Package VASSAL.build.module

Class EventLog

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.module.EventLog

All Implemented Interfaces:

Buildable, GameComponent, PropertyNameSource, CommandEncoder, ValidityChecker, ImageSearchTarget

public class EventLog
extends AbstractBuildable
implements CommandEncoder, GameComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventLog.Event
static class	EventLog.StoreEvents

Field Summary

Fields

Modifier and Type	Field	Description
static String	EVENT_LIST

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Constructor Summary

Constructors

Constructor	Description
EventLog()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable b)	Adds this component to its parent.
void	clearSaved()
Command	decode(String s)	Translate a String into a Command
static Iterable<EventLog.Event>	decodedEvents(String s)	Decodes a String into a sequence of Events.
static Enumeration<EventLog.Event>	decodeEvents(String s)	Deprecated, for removal: This API element is subject to removal in a future version. Use decodedEvents(String) instead.
String	encode(Command c)	Translate a Command into a String
static String	encodedEvents(Iterable<EventLog.Event> events)	Encodes a sequence of Events into a String.
static String	encodeEvents(Enumeration<?> e)	Deprecated, for removal: This API element is subject to removal in a future version. Use encodedEvents(Iterable) instead.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
String	getAttributeValueString(String name)
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
void	log(EventLog.Event e)
void	setAttribute(String name, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setup(boolean starting)	Notify the GameComponent that a game has started/ended
void	store(EventLog.Event e)

Methods inherited from class VASSAL.build.AbstractBuildable

add, addImageNamesRecursively, build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Field Details

EVENT_LIST

public static final String EVENT_LIST

See Also:

Constant Field Values

Constructor Details

EventLog

public EventLog()

Method Details

addTo

public void addTo(Buildable b)

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:

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

clearSaved

public void clearSaved()

store

public void store(EventLog.Event e)

log

public void log(EventLog.Event e)

decode

public Command decode(String s)

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

setup

public void setup(boolean starting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Parameters:

starting - if true, a game is starting. If false, then a game is ending

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

decodedEvents

public static Iterable<EventLog.Event> decodedEvents(String s)

Decodes a String into a sequence of Events.

Parameters:

s - the event string

Returns:

the events represented by the string

decodeEvents

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static Enumeration<EventLog.Event> decodeEvents(String s)

Deprecated, for removal: This API element is subject to removal in a future version.

Use decodedEvents(String) instead.

encodedEvents

public static String encodedEvents(Iterable<EventLog.Event> events)

Encodes a sequence of Events into a String.

Parameters:

events - the sequence of events

Returns:

the string representing the events

encodeEvents

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static String encodeEvents(Enumeration<?> e)

Deprecated, for removal: This API element is subject to removal in a future version.

Use encodedEvents(Iterable) instead.

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

setAttribute

public void setAttribute(String name,
 Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in class AbstractBuildable

Parameters:

name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getAttributeValueString

public String getAttributeValueString(String name)

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.