artisynth.core.modelbase

Class CompositeState

java.lang.Object

artisynth.core.modelbase.CompositeState

All Implemented Interfaces:

ComponentState, java.io.Serializable, Scannable

public class CompositeState
extends java.lang.Object
implements ComponentState

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompositeState()
CompositeState(boolean annotated)
CompositeState(int capacity)

Method Summary

Modifier and Type	Method and Description
void	addState(ComponentState state)
void	clear()
CompositeState	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.
ComponentState	getState(int i)
java.util.Iterator<ComponentState>	getStates()
boolean	isAnnotated() Queries whether or not this state is annotated.
boolean	isWritable() Returns true if this component should in fact be written to secondary storage.
int	numSubStates()
void	printState(int indent) Debugging method to print the structure of a composite state
void	readBinary(java.io.DataInputStream dis) Read this state (in binary format) from a data input stream.
void	removeState(ComponentState state)
void	scan(ReaderTokenizer rtok, java.lang.Object ref) Scans this element from a ReaderTokenizer.
void	set(ComponentState stateToCopy) Sets this state by copying the value from an existing state object.
void	set(CompositeState state)
void	setAnnotated(boolean annotated) Requests that this state be annotated.
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

Constructor Detail

CompositeState

public CompositeState()

CompositeState

public CompositeState(boolean annotated)

CompositeState

public CompositeState(int capacity)

Method Detail

getStates

public java.util.Iterator<ComponentState> getStates()

getState

public ComponentState getState(int i)

addState

public void addState(ComponentState state)

removeState

public void removeState(ComponentState state)

numSubStates

public int numSubStates()

clear

public void clear()

equals

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

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.

writeBinary

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

Description copied from interface: ComponentState

Writes this state (in binary format) to a data output stream.

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

Description copied from interface: ComponentState

Read this state (in binary format) from a data input stream.

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.

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.

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

set

public void set(ComponentState stateToCopy)

Description copied from interface: ComponentState

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

Specified by:

set in interface ComponentState

Parameters:

stateToCopy - state object to copy

set

public void set(CompositeState state)

duplicate

public CompositeState duplicate()

Description copied from interface: ComponentState

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

printState

public void printState(int indent)

Debugging method to print the structure of a composite state

isAnnotated

public boolean isAnnotated()

Queries whether or not this state is annotated. Annotation means that the state may contain additional information about its contents. In particular, this can be used to give details about how two states differ (via the msg argument to equals(state,msg).

Specified by:

isAnnotated in interface ComponentState

Returns:

true if this state is annotated.

setAnnotated

public void setAnnotated(boolean annotated)

Requests that this state be annotated. See ComponentState.isAnnotated() for more details.

Support for this method is optional. Applications should check isAnnotated() to determine if the request has been honored.

Specified by:

setAnnotated in interface ComponentState

Parameters:

annotated - if true, requests that this state be annotated.