Class BshCommandEncoder

java.lang.Object

VASSAL.build.module.BasicCommandEncoder

VASSAL.script.BshCommandEncoder

All Implemented Interfaces:

Buildable, CommandEncoder

public class BshCommandEncoder
extends BasicCommandEncoder

Used by the Bsh Plugin

Author:

Brent

Nested Class Summary

Nested classes/interfaces inherited from class BasicCommandEncoder

BasicCommandEncoder.BasicPieceFactory, BasicCommandEncoder.DecoratorFactory

Modifier and Type	Class	Description
static interface	BasicCommandEncoder.BasicPieceFactory	Factory interface for BasicPieces.
static interface	BasicCommandEncoder.DecoratorFactory	Factory interface for Decorators See: Decorator Pattern, Factory Pattern

Field Summary

Fields inherited from class BasicCommandEncoder

ADD, CHANGE, MOVE, REMOVE

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

Constructor Summary

Constructors

Constructor	Description
BshCommandEncoder()

Method Summary

Modifier and Type	Method	Description
Decorator	createDecorator(String type, GamePiece inner)	Creates a Decorator instance - a GamePiece "Trait".

Methods inherited from class BasicCommandEncoder

add, addTo, build, createBasic, createPiece, decode, encode, getBuildElement

Modifier and Type	Method	Description
void	add(Buildable b)	Adds a buildable subcomponent.
void	addTo(Buildable parent)	Adds this BasicCommandEncoder to its parent, which should be the GameModule.
void	build(Element e)	Build a BasicCommandEncoder from the XML buildFile.
protected GamePiece	createBasic(String type)	Create a GamePiece instance that is not a Decorator ("Trait").
GamePiece	createPiece(String type)	Creates a GamePiece instance from the given type information.
Command	decode(String command)	Deserializes a string into a Basic Piece command (Add, Remove, Change, Move, and...
String	encode(Command c)	Serializes a Basic Piece command (Add, Remove, Change, Move, and ...
Element	getBuildElement(Document doc)

Methods inherited from class Object

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

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Constructor Details

BshCommandEncoder

public BshCommandEncoder()

Method Details

createDecorator

public Decorator createDecorator(String type,
 GamePiece inner)

Description copied from class: BasicCommandEncoder

Creates a Decorator instance - a GamePiece "Trait". Modules which wish to provide their own custom classes should subclass BasicCommandEncoder and override this class. The override should check for and parse any definitions that match desired custom Traits(Decorators), and then use super to call this method for any unmatched definitions. Further documentation on creating custom traits appears in BasicCommandEncoder's own javadoc entry, or alternatively at the top of BasicCommandEncoder.java.

Overrides:

createDecorator in class BasicCommandEncoder

Parameters:

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

inner - the inner trait/piece of the Decorator (the "innermost" member of a game piece will be a BasicPiece; each successive Trait in the trait list presented in a piece's

invalid reference

PieceDefiner

dialog represents a sep "outward").