FilterSourcesMojo

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.codehaus.mojo.templating.AbstractFilterSourcesMojo
  - - org.codehaus.mojo.templating.FilterSourcesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="filter-sources",
      defaultPhase=GENERATE_SOURCES,
      threadSafe=true)
public class FilterSourcesMojo
extends AbstractFilterSourcesMojo
```
This mojo helps adding a filtered source folder in one go. This is typically useful if you want to use properties coming from the POM inside parts of your source code that requires real constants, like annotations for example.

Field Summary

Fields
Modifier and Type	Field	Description
`private java.io.File`	`outputDirectory`	Output folder where filtered sources will land.
`(package private) java.io.File`	`sourceDirectory`	Source directory that will be first filtered and then added as a classical source folder.

Fields inherited from class org.codehaus.mojo.templating.AbstractFilterSourcesMojo
delimiters, escapeString, mavenResourcesFiltering, overwrite, skipPoms, useDefaultDelimiters

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

Constructor Summary

Constructors
Constructor Description

FilterSourcesMojo()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addSourceFolderToProject(org.apache.maven.project.MavenProject mavenProject)`
`protected java.io.File`	`getOutputDirectory()`
`protected java.io.File`	`getSourceDirectory()`

Methods inherited from class org.codehaus.mojo.templating.AbstractFilterSourcesMojo
countCopiedFiles, execute

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 Detail
  - sourceDirectory
```
@Parameter(defaultValue="${basedir}/src/main/java-templates")
java.io.File sourceDirectory
```
    Source directory that will be first filtered and then added as a classical source folder.
  - outputDirectory
```
@Parameter(defaultValue="${project.build.directory}/generated-sources/java-templates")
private java.io.File outputDirectory
```
    Output folder where filtered sources will land.
- Constructor Detail
  - FilterSourcesMojo
```
public FilterSourcesMojo()
```
- Method Detail
  - getSourceDirectory
```
protected java.io.File getSourceDirectory()
```
    Specified by:
    
    getSourceDirectory in class AbstractFilterSourcesMojo
    
    Returns:
    
    The location of the source directory.
  - getOutputDirectory
```
protected java.io.File getOutputDirectory()
```
    Specified by:
    
    getOutputDirectory in class AbstractFilterSourcesMojo
    
    Returns:
    
    The location of the output directory.
  - addSourceFolderToProject
```
protected void addSourceFolderToProject(org.apache.maven.project.MavenProject mavenProject)
```
    Specified by:
    
    addSourceFolderToProject in class AbstractFilterSourcesMojo
    
    Parameters:
    
    mavenProject - MavenProject