AbstractFlattenMojo

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.codehaus.mojo.flatten.AbstractFlattenMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

CleanMojo, FlattenMojo
```
public abstract class AbstractFlattenMojo
extends org.apache.maven.plugin.AbstractMojo
```
This is the abstract base class for MOJOs that realize the different goals of this plugin.

Field Summary

Fields
Modifier and Type	Field	Description
`private java.lang.String`	`flattenedPomFilename`	The filename of the generated flattened POM file.
`private java.io.File`	`outputDirectory`	The directory where the generated flattened POM file will be written to.
`private boolean`	`skip`	If `true` the plugin will be skipped.

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

Constructor Summary

Constructors
Constructor Description

AbstractFlattenMojo()
The constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.io.File`	`getFlattenedPomFile()`
`java.lang.String`	`getFlattenedPomFilename()`
`java.io.File`	`getOutputDirectory()`
`protected boolean`	`shouldSkip()`
`protected abstract boolean`	`shouldSkipGoal()`

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

- Field Detail
  - outputDirectory
```
@Parameter(defaultValue="${project.basedir}")
private java.io.File outputDirectory
```
    The directory where the generated flattened POM file will be written to.
  - flattenedPomFilename
```
@Parameter(property="flattenedPomFilename",
           defaultValue=".flattened-pom.xml")
private java.lang.String flattenedPomFilename
```
    The filename of the generated flattened POM file.
  - skip
```
@Parameter(property="flatten.skip",
           defaultValue="false")
private boolean skip
```
    If true the plugin will be skipped.
    
    Since:
    
    1.6.0
- Constructor Detail
  - AbstractFlattenMojo
```
public AbstractFlattenMojo()
```
    The constructor.
- Method Detail
  - getFlattenedPomFilename
```
public java.lang.String getFlattenedPomFilename()
```
    Returns:
    
    the filename of the generated flattened POM file.
  - getOutputDirectory
```
public java.io.File getOutputDirectory()
```
    Returns:
    
    the directory where the generated flattened POM file will be written to.
  - getFlattenedPomFile
```
protected java.io.File getFlattenedPomFile()
```
    Returns:
    
    a File instance pointing to the flattened POM.
  - shouldSkip
```
protected boolean shouldSkip()
```
  - shouldSkipGoal
```
protected abstract boolean shouldSkipGoal()
```