Package org.apache.maven.model

Class ConfigurationContainer

java.lang.Object

org.apache.maven.model.ConfigurationContainer

All Implemented Interfaces:

Serializable, Cloneable, InputLocationTracker

Direct Known Subclasses:

Plugin, PluginExecution, ReportPlugin, ReportSet

public class ConfigurationContainer
extends Object
implements Serializable, Cloneable, InputLocationTracker

Contains the configuration information of the container like Plugin.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConfigurationContainer()

Method Summary

Modifier and Type	Method	Description
ConfigurationContainer	clone()	Method clone.
Object	getConfiguration()	Get
String	getInherited()	Get whether any configuration should be propagated to child POMs.
InputLocation	getLocation(Object key)	Gets the location of the specified field in the input source.
boolean	isInheritanceApplied()
boolean	isInherited()
void	setConfiguration(Object configuration)	Set
void	setInherited(boolean inherited)
void	setInherited(String inherited)	Set whether any configuration should be propagated to child POMs.
void	setLocation(Object key, InputLocation location)	Sets the location of the specified field.
void	setOtherLocation(Object key, InputLocation location)
void	unsetInheritanceApplied()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationContainer

public ConfigurationContainer()

Method Detail

clone

public ConfigurationContainer clone()

Method clone.

Overrides:

clone in class Object

Returns:

ConfigurationContainer

getConfiguration

public Object getConfiguration()

Get

The configuration as DOM object.

By default, every element content is trimmed, but starting with Maven 3.1.0, you can add xml:space="preserve" to elements you want to preserve whitespace.

You can control how child POMs inherit configuration from parent POMs by adding combine.children or combine.self attributes to the children of the configuration element:

• combine.children: available values are merge (default) and append,
• combine.self: available values are merge (default) and override.

See POM Reference documentation and Xpp3DomUtils for more information.

Returns:

Object

getInherited

public String getInherited()

Get whether any configuration should be propagated to child POMs. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is true.

Returns:

String

getLocation

public InputLocation getLocation(Object key)

Description copied from interface: InputLocationTracker

Gets the location of the specified field in the input source.

Specified by:

getLocation in interface InputLocationTracker

Parameters:

key - a key object.

Returns:

InputLocation

setLocation

public void setLocation(Object key,
                        InputLocation location)

Description copied from interface: InputLocationTracker

Sets the location of the specified field.

Specified by:

setLocation in interface InputLocationTracker

Parameters:

key - a key object.

location - a location object.

setOtherLocation

public void setOtherLocation(Object key,
                             InputLocation location)

Parameters:

key - a key object.

location - a location object.

setConfiguration

public void setConfiguration(Object configuration)

Set

The configuration as DOM object.

By default, every element content is trimmed, but starting with Maven 3.1.0, you can add xml:space="preserve" to elements you want to preserve whitespace.

You can control how child POMs inherit configuration from parent POMs by adding combine.children or combine.self attributes to the children of the configuration element:

• combine.children: available values are merge (default) and append,
• combine.self: available values are merge (default) and override.

See POM Reference documentation and Xpp3DomUtils for more information.

Parameters:

configuration - a configuration object.

setInherited

public void setInherited(String inherited)

Set whether any configuration should be propagated to child POMs. Note: While the type of this field is String for technical reasons, the semantic type is actually Boolean. Default value is true.

Parameters:

inherited - a inherited object.

isInherited

public boolean isInherited()

setInherited

public void setInherited(boolean inherited)

unsetInheritanceApplied

public void unsetInheritanceApplied()

isInheritanceApplied

public boolean isInheritanceApplied()