Package software.xdev.far.filecontents

Class FileContentsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

software.xdev.far.BaseMojo<FileContentsExecData>

software.xdev.far.filecontents.FileContentsMojo

All Implemented Interfaces:

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

@Mojo(name="file-contents",
      defaultPhase=NONE,
      threadSafe=true)
public class FileContentsMojo
extends BaseMojo<FileContentsExecData>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	encoding	Specify file encoding during file-contents replacement
protected boolean	replaceLineBased	Specify to match line based or otherwise match the whole document.

Fields inherited from class software.xdev.far.BaseMojo

baseDir, exclusions, executeInternal, fileMask, findRegex, project, recursive, replaceAll, replaceValue, skip

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

ROLE

Constructor Summary

Constructors

Constructor	Description
FileContentsMojo()

Method Summary

Modifier and Type	Method	Description
protected Pattern	compileFindRegex()
protected FileContentsExecData	enrichData(ExecData data)
void	setEncoding(String encoding)
void	setReplaceLineBased(boolean replaceLineBased)

Methods inherited from class software.xdev.far.BaseMojo

createDefaultData, execute, setBaseDir, setExclusions, setFileMask, setFindRegex, setProject, setRecursive, setReplaceAll, setReplaceValue, setSkip

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

Field Details

encoding

@Parameter(property="encoding")
protected String encoding

Specify file encoding during file-contents replacement

Default set to Charset.defaultCharset();

replaceLineBased

@Parameter(property="replaceLineBased",
           defaultValue="true")
protected boolean replaceLineBased

Specify to match line based or otherwise match the whole document.

When this value is set to false more memory may be required as the whole file is processed at once.

Constructor Details

FileContentsMojo

public FileContentsMojo()

Method Details

enrichData

protected FileContentsExecData enrichData(ExecData data)

Specified by:

enrichData in class BaseMojo<FileContentsExecData>

compileFindRegex

protected Pattern compileFindRegex()

Overrides:

compileFindRegex in class BaseMojo<FileContentsExecData>

setEncoding

public void setEncoding(String encoding)

setReplaceLineBased

public void setReplaceLineBased(boolean replaceLineBased)