com.soebes.maven.plugins.iterator

Class AbstractIteratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.soebes.maven.plugins.iterator.AbstractIteratorMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractInvokerMojo, IteratorMojo

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

Author:

Karl-Heinz Marbaise khmarbaise@apache.org

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractIteratorMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected Comparator<File>	convertSortOrder()
String	getBeginToken()
String	getContent()
String	getDelimiter()
String	getEndToken()
File	getFolder()
List<String>	getFolders()
List<String>	getItems()
protected List<ItemWithProperties>	getItemsConverted() Convert all types content, items or ItemsWithProperties into the same type.
List<ItemWithProperties>	getItemsWithProperties()
String	getIteratorName()
org.apache.maven.project.MavenProject	getMavenProject()
org.apache.maven.execution.MavenSession	getMavenSession()
protected String	getPlaceHolder() This is just a convenience method to get the combination of getBeginToken(), getIteratorName() and getEndToken().
String	getSortOrder()
protected boolean	isContentNull()
protected boolean	isContentSet()
boolean	isFailAtEnd()
protected boolean	isFolderNull()
protected boolean	isFolderSet()
protected boolean	isItemsNull()
protected boolean	isItemsSet()
protected boolean	isItemsWithPropertiesNull()
protected boolean	isItemsWithPropertiesSet()
protected boolean	isMoreThanOneSet()
protected boolean	isNoneSet()
boolean	isSkip()
boolean	isSortOrderValid(String sortOrder)
void	setBeginToken(String beginToken)
void	setContent(String content)
void	setDelimiter(String delimiter)
void	setEndToken(String endToken)
void	setFolder(File folder)
void	setItems(List<String> items)
void	setItemsWithProperties(List<ItemWithProperties> itemsWithProperties)
void	setIteratorName(String iteratorName)
void	setMavenProject(org.apache.maven.project.MavenProject mavenProject)
void	setMavenSession(org.apache.maven.execution.MavenSession mavenSession)
void	setSortOrder(String sortOrder)

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

AbstractIteratorMojo

public AbstractIteratorMojo()

Method Detail

isSortOrderValid

public boolean isSortOrderValid(String sortOrder)

convertSortOrder

protected Comparator<File> convertSortOrder()

getFolders

public List<String> getFolders()
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getItemsConverted

protected List<ItemWithProperties> getItemsConverted()
                                              throws org.apache.maven.plugin.MojoExecutionException

Convert all types content, items or ItemsWithProperties into the same type.

Returns:

list ItemWithProperties

Throws:

org.apache.maven.plugin.MojoExecutionException - In case of an error.

getPlaceHolder

protected String getPlaceHolder()

This is just a convenience method to get the combination of getBeginToken(), getIteratorName() and getEndToken().

Returns:

The combined string.

isItemsNull

protected boolean isItemsNull()

isItemsWithPropertiesNull

protected boolean isItemsWithPropertiesNull()

isItemsWithPropertiesSet

protected boolean isItemsWithPropertiesSet()

isItemsSet

protected boolean isItemsSet()

isContentNull

protected boolean isContentNull()

isContentSet

protected boolean isContentSet()

isFolderSet

protected boolean isFolderSet()

isFolderNull

protected boolean isFolderNull()

getFolder

public File getFolder()

setFolder

public void setFolder(File folder)

isMoreThanOneSet

protected boolean isMoreThanOneSet()

isNoneSet

protected boolean isNoneSet()

setSortOrder

public void setSortOrder(String sortOrder)

getSortOrder

public String getSortOrder()

getContent

public String getContent()

setContent

public void setContent(String content)

getDelimiter

public String getDelimiter()

setDelimiter

public void setDelimiter(String delimiter)

getBeginToken

public String getBeginToken()

setBeginToken

public void setBeginToken(String beginToken)

getEndToken

public String getEndToken()

setEndToken

public void setEndToken(String endToken)

getIteratorName

public String getIteratorName()

setIteratorName

public void setIteratorName(String iteratorName)

setItems

public void setItems(List<String> items)

getItems

public List<String> getItems()

isSkip

public boolean isSkip()

isFailAtEnd

public boolean isFailAtEnd()

getItemsWithProperties

public List<ItemWithProperties> getItemsWithProperties()

setItemsWithProperties

public void setItemsWithProperties(List<ItemWithProperties> itemsWithProperties)

getMavenProject

public org.apache.maven.project.MavenProject getMavenProject()

setMavenProject

public void setMavenProject(org.apache.maven.project.MavenProject mavenProject)

getMavenSession

public org.apache.maven.execution.MavenSession getMavenSession()

setMavenSession

public void setMavenSession(org.apache.maven.execution.MavenSession mavenSession)