BuildOverlay (Maven 2.2.1 API)

java.lang.Object
- org.apache.maven.model.PluginContainer
- - org.apache.maven.model.PluginConfiguration
  - - org.apache.maven.model.BuildBase
    - - org.apache.maven.model.Build
      - org.apache.maven.project.overlay.BuildOverlay

All Implemented Interfaces:

Serializable
```
public class BuildOverlay
extends Build
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

BuildOverlay(Build build)

Constructors
Constructor and Description
`BuildOverlay(Build build)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtension(Extension extension)` Method addExtension.
`void`	`addFilter(String string)` Method addFilter.
`void`	`addPlugin(Plugin plugin)` Method addPlugin.
`void`	`addResource(Resource resource)` Method addResource.
`void`	`addTestResource(Resource resource)` Method addTestResource.
`boolean`	`equals(Object obj)`
`void`	`flushPluginMap()` Reset the `pluginsMap` field to `null`
`String`	`getDefaultGoal()` Get the default goal (or phase in Maven 2) to execute when none is specified for the project.
`String`	`getDirectory()` Get the directory where all files generated by the build are placed.
`List`	`getExtensions()` Method getExtensions.
`List`	`getFilters()` Method getFilters.
`String`	`getFinalName()` Get the filename (excluding the extension, and with no path information) that the produced artifact will be called.
`String`	`getOutputDirectory()` Get the directory where compiled application classes are placed.
`PluginManagement`	`getPluginManagement()` Get default plugin information to be made available for reference by projects derived from this one.
`List`	`getPlugins()` Method getPlugins.
`Map`	`getPluginsAsMap()`
`List`	`getResources()` Method getResources.
`String`	`getScriptSourceDirectory()` Get this element specifies a directory containing the script sources of the project.
`String`	`getSourceDirectory()` Get this element specifies a directory containing the source of the project.
`String`	`getTestOutputDirectory()` Get the directory where compiled test classes are placed.
`List`	`getTestResources()` Method getTestResources.
`String`	`getTestSourceDirectory()` Get this element specifies a directory containing the unit test source of the project.
`int`	`hashCode()`
`void`	`removeExtension(Extension extension)` Method removeExtension.
`void`	`removeFilter(String string)` Method removeFilter.
`void`	`removePlugin(Plugin plugin)` Method removePlugin.
`void`	`removeResource(Resource resource)` Method removeResource.
`void`	`removeTestResource(Resource resource)` Method removeTestResource.
`void`	`setDefaultGoal(String defaultGoal)` Set the default goal (or phase in Maven 2) to execute when none is specified for the project.
`void`	`setDirectory(String directory)` Set the directory where all files generated by the build are placed.
`void`	`setExtensions(List extensions)` Set a set of build extensions to use from this project.
`void`	`setFilters(List filters)` Set the list of filter properties files that are used when filtering is enabled.
`void`	`setFinalName(String finalName)` Set the filename (excluding the extension, and with no path information) that the produced artifact will be called.
`void`	`setOutputDirectory(String outputDirectory)` Set the directory where compiled application classes are placed.
`void`	`setPluginManagement(PluginManagement pluginManagement)` Set default plugin information to be made available for reference by projects derived from this one.
`void`	`setPlugins(List plugins)` Set the list of plugins to use.
`void`	`setResources(List resources)` Set this element describes all of the classpath resources such as properties files associated with a project.
`void`	`setScriptSourceDirectory(String scriptSourceDirectory)` Set this element specifies a directory containing the script sources of the project.
`void`	`setSourceDirectory(String sourceDirectory)` Set this element specifies a directory containing the source of the project.
`void`	`setTestOutputDirectory(String testOutputDirectory)` Set the directory where compiled test classes are placed.
`void`	`setTestResources(List testResources)` Set this element describes all of the classpath resources such as properties files associated with a project's unit tests.
`void`	`setTestSourceDirectory(String testSourceDirectory)` Set this element specifies a directory containing the unit test source of the project.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BuildOverlay
```
public BuildOverlay(Build build)
```
- Method Detail
  - addExtension
```
public void addExtension(Extension extension)
```
    Description copied from class: Build
    
    Method addExtension.
    
    Overrides:
    
    addExtension in class Build
    
    Parameters:
    
    extension - a extension object.
  - addPlugin
```
public void addPlugin(Plugin plugin)
```
    Description copied from class: PluginContainer
    
    Method addPlugin.
    
    Overrides:
    
    addPlugin in class PluginContainer
    
    Parameters:
    
    plugin - a plugin object.
  - addResource
```
public void addResource(Resource resource)
```
    Description copied from class: BuildBase
    
    Method addResource.
    
    Overrides:
    
    addResource in class BuildBase
    
    Parameters:
    
    resource - a resource object.
  - addTestResource
```
public void addTestResource(Resource resource)
```
    Description copied from class: BuildBase
    
    Method addTestResource.
    
    Overrides:
    
    addTestResource in class BuildBase
    
    Parameters:
    
    resource - a resource object.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - flushPluginMap
```
public void flushPluginMap()
```
    Description copied from class: PluginContainer
    
    Reset the pluginsMap field to null
    
    Overrides:
    
    flushPluginMap in class PluginContainer
  - getDefaultGoal
```
public String getDefaultGoal()
```
    Description copied from class: BuildBase
    
    Get the default goal (or phase in Maven 2) to execute when none is specified for the project.
    
    Overrides:
    
    getDefaultGoal in class BuildBase
    
    Returns:
    
    String
  - getDirectory
```
public String getDirectory()
```
    Description copied from class: BuildBase
    
    Get the directory where all files generated by the build are placed.
    
    Overrides:
    
    getDirectory in class BuildBase
    
    Returns:
    
    String
  - getExtensions
```
public List getExtensions()
```
    Description copied from class: Build
    
    Method getExtensions.
    
    Overrides:
    
    getExtensions in class Build
    
    Returns:
    
    List
  - getFinalName
```
public String getFinalName()
```
    Description copied from class: BuildBase
    
    Get the filename (excluding the extension, and with no path information) that the produced artifact will be called. The default value is ${artifactId}-${version}.
    
    Overrides:
    
    getFinalName in class BuildBase
    
    Returns:
    
    String
  - getOutputDirectory
```
public String getOutputDirectory()
```
    Description copied from class: Build
    
    Get the directory where compiled application classes are placed.
    
    Overrides:
    
    getOutputDirectory in class Build
    
    Returns:
    
    String
  - getPluginManagement
```
public PluginManagement getPluginManagement()
```
    Description copied from class: PluginConfiguration
    
    Get default plugin information to be made available for reference by projects derived from this one. This plugin configuration will not be resolved or bound to the lifecycle unless referenced. Any local configuration for a given plugin will override the plugin's entire definition here.
    
    Overrides:
    
    getPluginManagement in class PluginConfiguration
    
    Returns:
    
    PluginManagement
  - getPlugins
```
public List getPlugins()
```
    Description copied from class: PluginContainer
    
    Method getPlugins.
    
    Overrides:
    
    getPlugins in class PluginContainer
    
    Returns:
    
    List
  - getPluginsAsMap
```
public Map getPluginsAsMap()
```
    Overrides:
    
    getPluginsAsMap in class PluginContainer
    
    Returns:
    
    a Map of plugins field with Plugins#getKey() as key
    
    See Also:
    
    Plugin.getKey()
  - getResources
```
public List getResources()
```
    Description copied from class: BuildBase
    
    Method getResources.
    
    Overrides:
    
    getResources in class BuildBase
    
    Returns:
    
    List
  - getScriptSourceDirectory
```
public String getScriptSourceDirectory()
```
    Description copied from class: Build
    
    Get this element specifies a directory containing the script sources of the project. This directory is meant to be different from the sourceDirectory, in that its contents will be copied to the output directory in most cases (since scripts are interpreted rather than compiled).
    
    Overrides:
    
    getScriptSourceDirectory in class Build
    
    Returns:
    
    String
  - getSourceDirectory
```
public String getSourceDirectory()
```
    Description copied from class: Build
    
    Get this element specifies a directory containing the source of the project. The generated build system will compile the source in this directory when the project is built. The path given is relative to the project descriptor.
    
    Overrides:
    
    getSourceDirectory in class Build
    
    Returns:
    
    String
  - getTestOutputDirectory
```
public String getTestOutputDirectory()
```
    Description copied from class: Build
    
    Get the directory where compiled test classes are placed.
    
    Overrides:
    
    getTestOutputDirectory in class Build
    
    Returns:
    
    String
  - getTestResources
```
public List getTestResources()
```
    Description copied from class: BuildBase
    
    Method getTestResources.
    
    Overrides:
    
    getTestResources in class BuildBase
    
    Returns:
    
    List
  - getTestSourceDirectory
```
public String getTestSourceDirectory()
```
    Description copied from class: Build
    
    Get this element specifies a directory containing the unit test source of the project. The generated build system will compile these directories when the project is being tested. The path given is relative to the project descriptor.
    
    Overrides:
    
    getTestSourceDirectory in class Build
    
    Returns:
    
    String
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - removeExtension
```
public void removeExtension(Extension extension)
```
    Description copied from class: Build
    
    Method removeExtension.
    
    Overrides:
    
    removeExtension in class Build
    
    Parameters:
    
    extension - a extension object.
  - removePlugin
```
public void removePlugin(Plugin plugin)
```
    Description copied from class: PluginContainer
    
    Method removePlugin.
    
    Overrides:
    
    removePlugin in class PluginContainer
    
    Parameters:
    
    plugin - a plugin object.
  - removeResource
```
public void removeResource(Resource resource)
```
    Description copied from class: BuildBase
    
    Method removeResource.
    
    Overrides:
    
    removeResource in class BuildBase
    
    Parameters:
    
    resource - a resource object.
  - removeTestResource
```
public void removeTestResource(Resource resource)
```
    Description copied from class: BuildBase
    
    Method removeTestResource.
    
    Overrides:
    
    removeTestResource in class BuildBase
    
    Parameters:
    
    resource - a resource object.
  - setDefaultGoal
```
public void setDefaultGoal(String defaultGoal)
```
    Description copied from class: BuildBase
    
    Set the default goal (or phase in Maven 2) to execute when none is specified for the project.
    
    Overrides:
    
    setDefaultGoal in class BuildBase
    
    Parameters:
    
    defaultGoal - a defaultGoal object.
  - setDirectory
```
public void setDirectory(String directory)
```
    Description copied from class: BuildBase
    
    Set the directory where all files generated by the build are placed.
    
    Overrides:
    
    setDirectory in class BuildBase
    
    Parameters:
    
    directory - a directory object.
  - setExtensions
```
public void setExtensions(List extensions)
```
    Description copied from class: Build
    
    Set a set of build extensions to use from this project.
    
    Overrides:
    
    setExtensions in class Build
    
    Parameters:
    
    extensions - a extensions object.
  - setFinalName
```
public void setFinalName(String finalName)
```
    Description copied from class: BuildBase
    
    Set the filename (excluding the extension, and with no path information) that the produced artifact will be called. The default value is ${artifactId}-${version}.
    
    Overrides:
    
    setFinalName in class BuildBase
    
    Parameters:
    
    finalName - a finalName object.
  - setOutputDirectory
```
public void setOutputDirectory(String outputDirectory)
```
    Description copied from class: Build
    
    Set the directory where compiled application classes are placed.
    
    Overrides:
    
    setOutputDirectory in class Build
    
    Parameters:
    
    outputDirectory - a outputDirectory object.
  - setPluginManagement
```
public void setPluginManagement(PluginManagement pluginManagement)
```
    Description copied from class: PluginConfiguration
    
    Set default plugin information to be made available for reference by projects derived from this one. This plugin configuration will not be resolved or bound to the lifecycle unless referenced. Any local configuration for a given plugin will override the plugin's entire definition here.
    
    Overrides:
    
    setPluginManagement in class PluginConfiguration
    
    Parameters:
    
    pluginManagement - a pluginManagement object.
  - setPlugins
```
public void setPlugins(List plugins)
```
    Description copied from class: PluginContainer
    
    Set the list of plugins to use.
    
    Overrides:
    
    setPlugins in class PluginContainer
    
    Parameters:
    
    plugins - a plugins object.
  - setResources
```
public void setResources(List resources)
```
    Description copied from class: BuildBase
    
    Set this element describes all of the classpath resources such as properties files associated with a project. These resources are often included in the final package.
    
    Overrides:
    
    setResources in class BuildBase
    
    Parameters:
    
    resources - a resources object.
  - setScriptSourceDirectory
```
public void setScriptSourceDirectory(String scriptSourceDirectory)
```
    Description copied from class: Build
    
    Set this element specifies a directory containing the script sources of the project. This directory is meant to be different from the sourceDirectory, in that its contents will be copied to the output directory in most cases (since scripts are interpreted rather than compiled).
    
    Overrides:
    
    setScriptSourceDirectory in class Build
    
    Parameters:
    
    scriptSourceDirectory - a scriptSourceDirectory object.
  - setSourceDirectory
```
public void setSourceDirectory(String sourceDirectory)
```
    Description copied from class: Build
    
    Set this element specifies a directory containing the source of the project. The generated build system will compile the source in this directory when the project is built. The path given is relative to the project descriptor.
    
    Overrides:
    
    setSourceDirectory in class Build
    
    Parameters:
    
    sourceDirectory - a sourceDirectory object.
  - setTestOutputDirectory
```
public void setTestOutputDirectory(String testOutputDirectory)
```
    Description copied from class: Build
    
    Set the directory where compiled test classes are placed.
    
    Overrides:
    
    setTestOutputDirectory in class Build
    
    Parameters:
    
    testOutputDirectory - a testOutputDirectory object.
  - setTestResources
```
public void setTestResources(List testResources)
```
    Description copied from class: BuildBase
    
    Set this element describes all of the classpath resources such as properties files associated with a project's unit tests.
    
    Overrides:
    
    setTestResources in class BuildBase
    
    Parameters:
    
    testResources - a testResources object.
  - setTestSourceDirectory
```
public void setTestSourceDirectory(String testSourceDirectory)
```
    Description copied from class: Build
    
    Set this element specifies a directory containing the unit test source of the project. The generated build system will compile these directories when the project is being tested. The path given is relative to the project descriptor.
    
    Overrides:
    
    setTestSourceDirectory in class Build
    
    Parameters:
    
    testSourceDirectory - a testSourceDirectory object.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - addFilter
```
public void addFilter(String string)
```
    Description copied from class: BuildBase
    
    Method addFilter.
    
    Overrides:
    
    addFilter in class BuildBase
    
    Parameters:
    
    string - a string object.
  - getFilters
```
public List getFilters()
```
    Description copied from class: BuildBase
    
    Method getFilters.
    
    Overrides:
    
    getFilters in class BuildBase
    
    Returns:
    
    List
  - removeFilter
```
public void removeFilter(String string)
```
    Description copied from class: BuildBase
    
    Method removeFilter.
    
    Overrides:
    
    removeFilter in class BuildBase
    
    Parameters:
    
    string - a string object.
  - setFilters
```
public void setFilters(List filters)
```
    Description copied from class: BuildBase
    
    Set the list of filter properties files that are used when filtering is enabled.
    
    Overrides:
    
    setFilters in class BuildBase
    
    Parameters:
    
    filters - a filters object.

Class BuildOverlay

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BuildOverlay

Method Detail

addExtension

addPlugin

addResource

addTestResource

equals

flushPluginMap

getDefaultGoal

getDirectory

getExtensions

getFinalName

getOutputDirectory

getPluginManagement

getPlugins

getPluginsAsMap

getResources

getScriptSourceDirectory

getSourceDirectory

getTestOutputDirectory

getTestResources

getTestSourceDirectory

hashCode

removeExtension

removePlugin

removeResource

removeTestResource

setDefaultGoal

setDirectory

setExtensions

setFinalName

setOutputDirectory

setPluginManagement

setPlugins

setResources

setScriptSourceDirectory

setSourceDirectory

setTestOutputDirectory

setTestResources

setTestSourceDirectory

toString

addFilter

getFilters

removeFilter

setFilters