Package VASSAL.build.module

Class BasicCommandEncoder

java.lang.Object

VASSAL.build.module.BasicCommandEncoder

All Implemented Interfaces:

Buildable, CommandEncoder

Direct Known Subclasses:

BshCommandEncoder

public class BasicCommandEncoder
extends Object
implements CommandEncoder, Buildable

A CommandEncoder that handles the basic commands: AddPiece, RemovePiece, ChangePiece, MovePiece. If a module defines custom GamePiece classes, then this class may be overriden and imported into the module. Subclasses should override the createDecorator(java.lang.String, VASSAL.counters.GamePiece) method or, less often, the createBasic(java.lang.String) or createPiece(java.lang.String) methods to allow instantiation of the custom GamePiece classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BasicCommandEncoder.BasicPieceFactory
static interface	BasicCommandEncoder.DecoratorFactory

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADD
static String	CHANGE
static String	MOVE
static String	REMOVE

Constructor Summary

Constructors

Constructor	Description
BasicCommandEncoder()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Adds a child component.
void	addTo(Buildable parent)	Adds this component to its parent.
void	build(Element e)	Build the object
protected GamePiece	createBasic(String type)	Create a GamePiece instance that is not a Decorator
Decorator	createDecorator(String type, GamePiece inner)	Creates a Decorator instance
GamePiece	createPiece(String type)	Creates a GamePiece instance from the given type information.
Command	decode(String command)	Translate a String into a Command
String	encode(Command c)	Translate a Command into a String
Element	getBuildElement(Document doc)

Methods inherited from class java.lang.Object

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

Field Details

ADD

public static final String ADD

See Also:

Constant Field Values

REMOVE

public static final String REMOVE

See Also:

Constant Field Values

CHANGE

public static final String CHANGE

See Also:

Constant Field Values

MOVE

public static final String MOVE

See Also:

Constant Field Values

Constructor Details

BasicCommandEncoder

public BasicCommandEncoder()

Method Details

createDecorator

public Decorator createDecorator(String type,
GamePiece inner)

Creates a Decorator instance

Parameters:

type - the type of the Decorator to be created. Once created, the Decorator should return this value from its Decorator.myGetType() method.

inner - the inner piece of the Decorator

See Also:

Decorator

createBasic

protected GamePiece createBasic(String type)

Create a GamePiece instance that is not a Decorator

Parameters:

type - the type of the GamePiece. The created piece should return this value from its GamePiece.getType() method

createPiece

public GamePiece createPiece(String type)

Creates a GamePiece instance from the given type information. Determines from the type whether the represented piece is a Decorator or not and forwards to createDecorator(java.lang.String, VASSAL.counters.GamePiece) or createBasic(java.lang.String). This method should generally not need to be overridden. Instead, override createDecorator or createBasic

build

public void build(Element e)

Description copied from interface: Buildable

Build the object

Specified by:

build in interface Buildable

Parameters:

e - the XML element containing the object data

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 reponsible 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

add

public void add(Buildable b)

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

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Returns:

an XML element from which this component can be built

decode

public Command decode(String command)

Description copied from interface: CommandEncoder

Translate a String into a Command

Specified by:

decode in interface CommandEncoder

encode

public String encode(Command c)

Description copied from interface: CommandEncoder

Translate a Command into a String

Specified by:

encode in interface CommandEncoder