artisynth.core.modelbase

Class EmptyState

java.lang.Object

artisynth.core.modelbase.EmptyState

All Implemented Interfaces:

ComponentState, java.io.Serializable, Scannable

public class EmptyState
extends java.lang.Object
implements ComponentState

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EmptyState()

Method Summary

Modifier and Type	Method and Description
ComponentState	duplicate() Create a duplicate of this state which can be used for storing this state's values.
boolean	equals(ComponentState state, java.lang.StringBuilder msg) Returns true if this state equals another component state.
boolean	isWritable() Returns true if this component should in fact be written to secondary storage.
void	readBinary(java.io.DataInputStream dis) Read this state (in binary format) from a data input stream.
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
void	set(ComponentState state) Sets this state by copying the value from an existing state object.
void	write(java.io.PrintWriter pw, NumberFormat fmt, java.lang.Object ref) Writes a text description of this element to a PrintWriter.
void	writeBinary(java.io.DataOutputStream dos) Writes this state (in binary format) to a data output stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.modelbase.ComponentState

equals, isAnnotated, setAnnotated

Constructor Detail

EmptyState

public EmptyState()

Method Detail

writeBinary

public void writeBinary(java.io.DataOutputStream dos)
                 throws java.io.IOException

Writes this state (in binary format) to a data output stream. For the EmptyState, nothing is written.

Specified by:

writeBinary in interface ComponentState

Parameters:

dos - output stream to write model to

Throws:

java.io.IOException - if an I/O error occurred

readBinary

public void readBinary(java.io.DataInputStream dis)
                throws java.io.IOException

Read this state (in binary format) from a data input stream. For the EmptyState, nothing is read.

Specified by:

readBinary in interface ComponentState

Parameters:

dis - input stream to read model from

Throws:

java.io.IOException - if an I/O error occurred or if the input is incompatible with the current state configuration.

write

public void write(java.io.PrintWriter pw,
                  NumberFormat fmt,
                  java.lang.Object ref)
           throws java.io.IOException

Description copied from interface: Scannable

Writes a text description of this element to a PrintWriter. The text description should be compatable with scan and complete enough to allow full reconstruction of the element.

Specified by:

write in interface Scannable

Parameters:

pw - stream for writing the element

fmt - numeric formating information

ref - optional reference object which can be used for producing references to other objects

Throws:

java.io.IOException - if an I/O error occured

scan

public void scan(ReaderTokenizer rtok,
                 java.lang.Object ref)
          throws java.io.IOException

Description copied from interface: Scannable

Scans this element from a ReaderTokenizer. The expected text format is assumed to be compatible with that produced by write.

Specified by:

scan in interface Scannable

Parameters:

rtok - Tokenizer from which to scan the element

ref - optional reference object which can be used for resolving references to other objects

Throws:

java.io.IOException - if an I/O or formatting error occured

isWritable

public boolean isWritable()

Description copied from interface: Scannable

Returns true if this component should in fact be written to secondary storage. This gives subclasses control over whether or not they are actually written out.

Specified by:

isWritable in interface Scannable

Returns:

true if this component should be written to secondary storage.

set

public void set(ComponentState state)

Sets this state by copying the value from an existing state object.

Specified by:

set in interface ComponentState

Parameters:

state - state object to copy

Throws:

java.lang.IllegalArgumentException - if the state objects are incompatible

equals

public boolean equals(ComponentState state,
                      java.lang.StringBuilder msg)

Description copied from interface: ComponentState

Returns true if this state equals another component state.

Specified by:

equals in interface ComponentState

Parameters:

state - state to compare to

msg - If not null, can be used to append diagnostic information if the states are not equal.

duplicate

public ComponentState duplicate()

Create a duplicate of this state which can be used for storing this state's values.

Specified by:

duplicate in interface ComponentState

Returns:

duplicate of this state