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

Direct Known Subclasses:

ListUpdate, SetProperty

public abstract class Command
extends AbstractDataObject
implements BinaryDataObject

Base class of commands that encode changes to data objects.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	getId()	The network ID of the changed object.
SharedGraphNode	getNode()	Cache for the reference to the changed graph node itself.
String	getProperty()	The name of the changed property of the object with the given getId().
boolean	hasNode()	Checks, whether getNode() has a value.
protected void	internalSetId(int value)	Internal setter for getId() without chain call utility.
protected void	internalSetNode(SharedGraphNode value)	Internal setter for getNode() without chain call utility.
protected void	internalSetProperty(String value)	Internal setter for getProperty() without chain call utility.
abstract String	jsonType()	The type identifier for this concrete subtype.
abstract Command.TypeKind	kind()	The type code of this instance.
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	readContent(DataReader in)	Helper for reading all fields of this instance.
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	setId(int value)
Command	setNode(SharedGraphNode value)
Command	setProperty(String value)
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.
void	writeTo(DataWriter out)	Writes the content of this DataObject to the given binary output.
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

Constructor Detail

Command

protected Command()

Creates a Command instance.

Method Detail

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 Command setId(int value)

See Also:

getId()

internalSetId

protected final void internalSetId(int value)

Internal setter for getId() without chain call utility.

getProperty

public final String getProperty()

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

setProperty

public Command setProperty(String value)

See Also:

getProperty()

internalSetProperty

protected final void internalSetProperty(String value)

Internal setter for getProperty() without chain call utility.

getNode

public final SharedGraphNode getNode()

Cache for the reference to the changed graph node itself.

setNode

public Command setNode(SharedGraphNode value)

See Also:

getNode()

internalSetNode

protected final void internalSetNode(SharedGraphNode value)

Internal setter for getNode() without chain call utility.

hasNode

public final boolean hasNode()

Checks, whether getNode() has a value.

jsonType

public abstract String jsonType()

The type identifier for this concrete subtype.

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

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

readContent

protected final void readContent(DataReader in)
                          throws IOException

Helper for reading all fields of this instance.

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 extends Throwable

Accepts the given visitor.

Throws:

E extends Throwable