br.com.educode.plugin.goal

Class EducodeMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

br.com.educode.plugin.goal.EducodeMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

PutAgainMojo, RemoveMojo

public abstract class EducodeMojo
extends org.apache.maven.plugin.AbstractMojo

EducodeMojo Abstract class is super class to the daughter class that implements specific actions.

Since:

1.0-beta

Author:

Eduardo Vieira

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
EducodeMojo()

Method Summary

Modifier and Type	Method and Description
Document	getDocument()
String	getEncode()
String	getOutputPomFile()
String	getPomFile()
Boolean	getPrintConsole()
List<Node>	getSelectedDependencyNode(Document document) Select in project tag, parent tag, dependency tag and plugin tag that have in yours artifactId value equals to no-snapshot.artifactId values.
String	getSuffix()
void	init() It is for initialization of default values to EducodeMojo fields.
void	setEncode(String encode)
void	setOutputPomFile(String outputPomFile)
void	setPomFile(String pomFile)
void	setPrintConsole(Boolean printConsole)
void	setSuffix(String suffix)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Constructor Detail

EducodeMojo

public EducodeMojo()

See Also:

method.

Method Detail

init

public void init()

It is for initialization of default values to EducodeMojo fields.

getSelectedDependencyNode

public List<Node> getSelectedDependencyNode(Document document)
                                     throws org.apache.maven.plugin.MojoExecutionException

Select in project tag, parent tag, dependency tag and plugin tag that have in yours artifactId value equals to no-snapshot.artifactId values.

Parameters:

document - represents XML file.

Returns:

List of Node that contains all selected nodes.

Throws:

org.apache.maven.plugin.MojoExecutionException - Exception to any failure of execution.

See Also:

Node

getDocument

public Document getDocument()
                     throws ParserConfigurationException,
                            SAXException,
                            IOException

Returns:

Document represents XML File (POM).

Throws:

ParserConfigurationException - Consult documentation of the API.

SAXException - Consult documentation of the API.

IOException - Consult documentation of the API.

See Also:

Document

getPomFile

public String getPomFile()

Returns:

String that is address pom file.

setPomFile

public void setPomFile(String pomFile)

Parameters:

pomFile - is the address to access pom file.

getOutputPomFile

public String getOutputPomFile()

Returns:

String is output name to generated pom file.

setOutputPomFile

public void setOutputPomFile(String outputPomFile)

Parameters:

outputPomFile - that is output name to future generated pom file.

getSuffix

public String getSuffix()

Returns:

String that is represents suffix to concatenate with version value of the dependency.

setSuffix

public void setSuffix(String suffix)

Parameters:

suffix - is a String to be used in work with value version tag of dependency.

getEncode

public String getEncode()

Returns:

String that is represents charset encode of pom file.

setEncode

public void setEncode(String encode)

Parameters:

encode - is a String that represents charset encode of pom file.

getPrintConsole

public Boolean getPrintConsole()

Returns:

Boolean is to decide whether of content file is print in screen or not.

setPrintConsole

public void setPrintConsole(Boolean printConsole)

Parameters:

printConsole - is Boolean value for print or not in screen.