org.codehaus.mojo.properties
Class WriteProjectProperties

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.codehaus.mojo.properties.AbstractWritePropertiesMojo
          org.codehaus.mojo.properties.WriteProjectProperties

All Implemented Interfaces:

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

public class WriteProjectProperties
extends AbstractWritePropertiesMojo

Write project properties to a file.

Author:

Jeff Caddel

Field Summary

Fields inherited from class org.codehaus.mojo.properties.AbstractWritePropertiesMojo

outputFile, project

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

ROLE

Constructor Summary

WriteProjectProperties()

Method Summary

protected String	escape(String s, List<String> escapeChars)
void	execute()
protected String	getAntHeader()
protected String	getContent(String comment, Properties properties, List<String> escapeTokens)
protected static Properties	getEnvironmentVariables()
String	getEscapeChars()
protected List<String>	getEscapeChars(String escapeChars)
String	getExclude()
String	getInclude()
protected String	getRealToken(String token)
protected String	getReplacementToken(String escapeChar)
boolean	isAntEchoPropertiesMode()
boolean	isIncludeEnvironmentVariables()
boolean	isIncludeSystemProperties()
void	setAntEchoPropertiesMode(boolean antEchoPropertiesMode)
void	setEscapeChars(String escapeChars)
void	setExclude(String exclude)
void	setInclude(String include)
void	setIncludeEnvironmentVariables(boolean includeEnvironmentVariables)
void	setIncludeSystemProperties(boolean includeSystemProperties)
protected void	trim(Properties properties, String omitCSV, String includeCSV)
protected void	writeProperties(File file, String comment, Properties properties, List<String> escapeTokens)

Methods inherited from class org.codehaus.mojo.properties.AbstractWritePropertiesMojo

writeProperties

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

Constructor Detail

WriteProjectProperties

public WriteProjectProperties()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getEnvironmentVariables

protected static Properties getEnvironmentVariables()

trim

protected void trim(Properties properties,
                    String omitCSV,
                    String includeCSV)

getAntHeader

protected String getAntHeader()

getEscapeChars

protected List<String> getEscapeChars(String escapeChars)

getRealToken

protected String getRealToken(String token)

getContent

protected String getContent(String comment,
                            Properties properties,
                            List<String> escapeTokens)

writeProperties

protected void writeProperties(File file,
                               String comment,
                               Properties properties,
                               List<String> escapeTokens)
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

escape

protected String escape(String s,
                        List<String> escapeChars)

getReplacementToken

protected String getReplacementToken(String escapeChar)

isAntEchoPropertiesMode

public boolean isAntEchoPropertiesMode()

setAntEchoPropertiesMode

public void setAntEchoPropertiesMode(boolean antEchoPropertiesMode)

isIncludeSystemProperties

public boolean isIncludeSystemProperties()

setIncludeSystemProperties

public void setIncludeSystemProperties(boolean includeSystemProperties)

getEscapeChars

public String getEscapeChars()

setEscapeChars

public void setEscapeChars(String escapeChars)

isIncludeEnvironmentVariables

public boolean isIncludeEnvironmentVariables()

setIncludeEnvironmentVariables

public void setIncludeEnvironmentVariables(boolean includeEnvironmentVariables)

getExclude

public String getExclude()

setExclude

public void setExclude(String exclude)

getInclude

public String getInclude()

setInclude

public void setInclude(String include)