Package VASSAL.build.module

Class ExtensionElement

java.lang.Object

VASSAL.build.module.ExtensionElement

All Implemented Interfaces:

Buildable

public class ExtensionElement
extends Object
implements Buildable

An element of a ModuleExtension that extends an individual Buildable component of the GameModule.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TARGET	An identifier for the component to be extended

Constructor Summary

Constructors

Constructor	Description
ExtensionElement()
ExtensionElement(Buildable extension, Configurable[] targetPath)

Method Summary

Modifier and Type	Method	Description
void	add(Buildable child)	Adds a child component.
void	addTo(Buildable parent)	Adds this component to its parent.
void	build(Element e)	Build the object from the XML representation of the Buildable
Element	getBuildElement(Document doc)
Buildable	getExtension()
Configurable[]	getTargetPath()

Methods inherited from class java.lang.Object

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

Field Details

TARGET

public static final String TARGET

An identifier for the component to be extended

See Also:

Constant Field Values

Constructor Details

ExtensionElement

public ExtensionElement()

ExtensionElement

public ExtensionElement(Buildable extension,
 Configurable[] targetPath)

Method Details

add

public void add(Buildable child)

Description copied from interface: Buildable

Adds a child component. Both this method and Buildable.addTo(VASSAL.build.Buildable) are invoked when adding a child to a parent

Specified by:

add in interface Buildable

Parameters:

child - Child to attach to this buildable as a subcomponent

build

public void build(Element e)

Description copied from interface: Buildable

Build the object from the XML representation of the Buildable

Specified by:

build in interface Buildable

Parameters:

e - the XML element containing the object data

getExtension

public Buildable getExtension()

getTargetPath

public Configurable[] getTargetPath()

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Parameters:

doc - XML file

Returns:

an XML element from which this component can be built

addTo

public void addTo(Buildable parent)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

Parameters:

parent - parent Buildable to add this component to as a subcomponent.