com.flagstone.transform
Class FSVoid

java.lang.Object
  com.flagstone.transform.FSTransformObject
      com.flagstone.transform.FSVoid

All Implemented Interfaces:

java.lang.Cloneable

public class FSVoid
extends FSTransformObject

FSVoid is a lightweight object that is used solely to allow void values to be pushed onto the Flash Player stack by The FSPush class.

History

The FSVoid class represents the Void data type from the Macromedia Flash (SWF) File Format Specification. It was introduced in Flash 5.

Constructor Summary

FSVoid()
Constructs an FSVoid object.

Method Summary

void	appendDescription(java.lang.StringBuffer buffer, int depth) AppendDescription is used to present a string description of the object including all nested objects up to a specified depth.
void	decode(FSCoder coder)
void	encode(FSCoder coder)
static FSVoid	getInstance() Returns a canonical FSVoid object.
int	length(FSCoder coder)

Methods inherited from class com.flagstone.transform.FSTransformObject

clone, equals, name, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FSVoid

public FSVoid()

Constructs an FSVoid object.

Method Detail

getInstance

public static FSVoid getInstance()

Returns a canonical FSVoid object.

Returns:

an object that can safely be shared among objects.

appendDescription

public void appendDescription(java.lang.StringBuffer buffer,
                              int depth)

Description copied from class: FSTransformObject

AppendDescription is used to present a string description of the object including all nested objects up to a specified depth. This method provide a more controlled way of creating a string representation of an object since large objects such as font or shape definitions can contain dozens of nested objects. The representation of the object is appended to the StringBuffer, showing the name of the class and values of the attributes it contains. If the object contains any attributes that are objects then the object graph will be traversed up to the specified depth. If objects are nested at a level less than specified depth then the full string representation of the object is displayed. For objects at the specified depth only the name of the class is displayed. Any objects below this depth are not displayed.

Specified by:

appendDescription in class FSTransformObject

Parameters:

buffer - a StringBuffer to which the description of each object is appended.

depth - the maximum level of nesting up to which objects will be displayed.

length

public int length(FSCoder coder)

Specified by:

length in class FSTransformObject

encode

public void encode(FSCoder coder)

Specified by:

encode in class FSTransformObject

decode

public void decode(FSCoder coder)

Specified by:

decode in class FSTransformObject