Module de.haumacher.msgbuf

Package de.haumacher.msgbuf.graph.cmd

Class Command

java.lang.Object

de.haumacher.msgbuf.data.AbstractDataObject

de.haumacher.msgbuf.graph.cmd.Command

All Implemented Interfaces:

BinaryDataObject, DataObject, ReflectiveDataObject, Observable

Direct Known Subclasses:

ListUpdate, SetProperty

public abstract class Command
extends AbstractDataObject
implements BinaryDataObject, Observable

Base class of commands that encode changes to data objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Command.TypeKind	Type codes for the Command hierarchy.
static interface	Command.Visitor<R,A,E extends Throwable>	Visitor interface for the Command hierarchy.

Field Summary

Fields

Modifier and Type	Field	Description
protected Listener	_listener
static final String	ID
static final int	ID__ID	Identifier for the property getId() in binary format.
static final String	NODE
static final String	PROPERTY
static final int	PROPERTY__ID	Identifier for the property getProperty() in binary format.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Command()	Creates a Command instance.

Method Summary

Modifier and Type	Method	Description
Object	get(String field)	Retrieves value of the field with the given name.
final int	getId()	The network ID of the changed object.
final SharedGraphNode	getNode()	Cache for the reference to the changed graph node itself.
final String	getProperty()	The name of the changed property of the object with the given getId().
final boolean	hasNode()	Checks, whether getNode() has a value.
abstract Command.TypeKind	kind()	The type code of this instance.
List<String>	properties()	All properties that are supported by this object.
static Command	readCommand(DataReader in)	Reads a new instance from the given reader.
static Command	readCommand(JsonReader in)	Reads a new instance from the given reader.
protected void	readField(DataReader in, int field)	Consumes the value for the field with the given ID and assigns its value.
protected void	readField(JsonReader in, String field)	Reads the given field from the given input.
Command	registerListener(Listener l)	Attaches the given Listener to this object.
void	set(String field, Object value)	Sets the value of the property with the given name.
final Command	setId(int value)
final Command	setNode(SharedGraphNode value)
final Command	setProperty(String value)
abstract int	typeId()	The binary identifier for this concrete type in the polymorphic Command hierarchy.
Command	unregisterListener(Listener l)	Removes the given Listener from this object.
abstract <R, A, E extends Throwable> R	visit(Command.Visitor<R,A,E> v, A arg)	Accepts the given visitor.
protected void	writeFields(DataWriter out)	Serializes all fields of this instance to the given binary output.
protected void	writeFields(JsonWriter out)	Writes all fields of this instance to the given output.
final void	writeTo(DataWriter out)	Writes the content of this DataObject to the given binary output.
final void	writeTo(JsonWriter out)	Writes this instance to the given output.

Methods inherited from class de.haumacher.msgbuf.data.AbstractDataObject

readContent, readFields, toString, writeContent

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.haumacher.msgbuf.data.ReflectiveDataObject

jsonType

Field Details

ID

public static final String ID

See Also:

• getId()
• Constant Field Values

PROPERTY

public static final String PROPERTY

See Also:

• getProperty()
• Constant Field Values

NODE

public static final String NODE

See Also:

• getNode()
• Constant Field Values

ID__ID

public static final int ID__ID

Identifier for the property getId() in binary format.

See Also:

• Constant Field Values

PROPERTY__ID

public static final int PROPERTY__ID

Identifier for the property getProperty() in binary format.

See Also:

• Constant Field Values

_listener

protected Listener _listener

Constructor Details

Command

protected Command()

Creates a Command instance.

Method Details

kind

public abstract Command.TypeKind kind()

The type code of this instance.

getId

public final int getId()

The network ID of the changed object.

setId

public final Command setId(int value)

See Also:

• getId()

getProperty

public final String getProperty()

The name of the changed property of the object with the given getId().

setProperty

public final Command setProperty(String value)

See Also:

• getProperty()

getNode

public final SharedGraphNode getNode()

Cache for the reference to the changed graph node itself.

setNode

public final Command setNode(SharedGraphNode value)

See Also:

• getNode()

hasNode

public final boolean hasNode()

Checks, whether getNode() has a value.

registerListener

public Command registerListener(Listener l)

Description copied from interface: Observable

Attaches the given Listener to this object.

If the given Listener is already attached, it is not attached again.

Specified by:

registerListener in interface Observable

Parameters:

l - The Listener to attach.

Returns:

This object for call chaining.

unregisterListener

public Command unregisterListener(Listener l)

Description copied from interface: Observable

Removes the given Listener from this object.

Specified by:

unregisterListener in interface Observable

Parameters:

l - The Listener to remove.

Returns:

This object for call chaining.

properties

public List<String> properties()

Description copied from interface: ReflectiveDataObject

All properties that are supported by this object.

Specified by:

properties in interface ReflectiveDataObject

See Also:

• ReflectiveDataObject.get(String)

get

public Object get(String field)

Description copied from interface: ReflectiveDataObject

Retrieves value of the field with the given name.

Specified by:

get in interface ReflectiveDataObject

Parameters:

field - The name of the property.

Returns:

The value of the property with the given name.

See Also:

• ReflectiveDataObject.properties()

set

public void set(String field,
 Object value)

Description copied from interface: ReflectiveDataObject

Sets the value of the property with the given name.

Specified by:

set in interface ReflectiveDataObject

Parameters:

field - The name of the property to update.

value - The new value of the property.

See Also:

• ReflectiveDataObject.get(String)

readCommand

public static Command readCommand(JsonReader in)
                           throws IOException

Reads a new instance from the given reader.

Throws:

IOException

writeTo

public final void writeTo(JsonWriter out)
                   throws IOException

Description copied from interface: DataObject

Writes this instance to the given output.

Specified by:

writeTo in interface DataObject

Parameters:

out - The JsonWriter to write this instance to.

Throws:

IOException - if writing fails.

writeFields

protected void writeFields(JsonWriter out)
                    throws IOException

Description copied from class: AbstractDataObject

Writes all fields of this instance to the given output.

Overrides:

writeFields in class AbstractDataObject

Parameters:

out - The writer to write to.

Throws:

IOException - If writing fails.

readField

protected void readField(JsonReader in,
 String field)
                  throws IOException

Description copied from class: AbstractDataObject

Reads the given field from the given input.

Overrides:

readField in class AbstractDataObject

Parameters:

in - The reader to take the value from.

field - The name of the field whose value should be read.

Throws:

IOException

typeId

public abstract int typeId()

The binary identifier for this concrete type in the polymorphic Command hierarchy.

writeTo

public final void writeTo(DataWriter out)
                   throws IOException

Description copied from interface: BinaryDataObject

Writes the content of this DataObject to the given binary output.

Specified by:

writeTo in interface BinaryDataObject

Parameters:

out - The writer to write this object to.

Throws:

IOException - If writing fails.

writeFields

protected void writeFields(DataWriter out)
                    throws IOException

Serializes all fields of this instance to the given binary output.

Parameters:

out - The binary output to write to.

Throws:

IOException - If writing fails.

readCommand

public static Command readCommand(DataReader in)
                           throws IOException

Reads a new instance from the given reader.

Throws:

IOException

readField

protected void readField(DataReader in,
 int field)
                  throws IOException

Consumes the value for the field with the given ID and assigns its value.

Throws:

IOException

visit

public abstract <R,
A,
E extends Throwable> R visit(Command.Visitor<R,A,E> v,
 A arg)
                                           throws E

Accepts the given visitor.

Throws:

E extends Throwable