com.flagstone.transform
Class Free

java.lang.Object
  com.flagstone.transform.Free

All Implemented Interfaces:

Copyable<MovieTag>, SWFEncodeable, MovieTag

public final class Free
extends Object
implements MovieTag

Free deletes the object with the specified identifier, freeing up resources in the Flash Player.

Constructor Summary

Free(Free object)
Creates a Free initialised with a copy of the data from another object.

Free(int uid)
Creates a Free object with the specified identifier.

Free(SWFDecoder coder)
Creates and initialises a Free object using values encoded in the Flash binary format.

Method Summary

Free	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
int	getIdentifier() Get the identifier of the object to be deleted.
int	prepareToEncode(Context context) Prepare an object for encoding, returning the expected size of an object when it is encoded.
void	setIdentifier(int uid) Sets the identifier of the object to be deleted.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Free

public Free(SWFDecoder coder)
     throws IOException

Creates and initialises a Free object using values encoded in the Flash binary format.

Parameters:

coder - an SWFDecoder object that contains the encoded Flash data.

Throws:

IOException - if an error occurs while decoding the data.

Free

public Free(int uid)

Creates a Free object with the specified identifier.

Parameters:

uid - the unique identifier of the object to be deleted. Must be in the range 1..65535.

Free

public Free(Free object)

Creates a Free initialised with a copy of the data from another object.

Parameters:

object - a Free object used to initialise this one.

Method Detail

getIdentifier

public int getIdentifier()

Get the identifier of the object to be deleted.

Returns:

the object identifier.

setIdentifier

public void setIdentifier(int uid)

Sets the identifier of the object to be deleted.

Parameters:

uid - the identifier of the object to be deleted. Must be in the range 1..65535.

copy

public Free copy()

Creates a complete copy of this object.

Specified by:

copy in interface Copyable<MovieTag>

Returns:

a deep-copy of this object. New instances of mutable objects are copied and immutable instances are shared.

toString

public String toString()

Overrides:

toString in class Object

prepareToEncode

public int prepareToEncode(Context context)

Prepare an object for encoding, returning the expected size of an object when it is encoded. This method also used to initialise variables, such as offsets and flags that will be used when the object is encoded. Generally the method returns the size in bytes, however when called on objects that use bit fields such as shapes the methods will return the size in bits.

Specified by:

prepareToEncode in interface SWFEncodeable

Parameters:

context - an Context that allows information to be passed between objects to control how they are initialised for encoding.

Returns:

the size of the object when it is encoded.

encode

public void encode(SWFEncoder coder,
                   Context context)
            throws IOException

Encode an object to the Flash binary format.

Specified by:

encode in interface SWFEncodeable

Parameters:

coder - an SWFEncoder object.

context - an Context that allows information to be passed between objects to control how they are initialised for encoding.

Throws:

IOException - if an error occurs while encoding the object.