com.flagstone.transform
Class MovieData

java.lang.Object
  com.flagstone.transform.MovieData

All Implemented Interfaces:

Copyable<MovieTag>, SWFEncodeable, MovieTag

public final class MovieData
extends Object
implements MovieTag

MovieData is used to store one or more MovieTags which already have been encoded for writing to a Flash file.

You can use this class to either selectively decode the tags in a movie, so tags that are not of interest can be left encoded or to selectively encode tags that will not change when generating Flash files from a template.

Constructor Summary

MovieData(byte[] bytes)
Create a MovieData object containing a block of encoded MovieTag objects.

MovieData(MovieData object)
Creates and initialises a MovieData object using the values copied from another MovieData object.

Method Summary

MovieData	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
byte[]	getData() Get a copy the encoded MovieTag objects.
int	prepareToEncode(Context context) Prepare an object for encoding, returning the expected size of an object when it is encoded.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MovieData

public MovieData(byte[] bytes)

Create a MovieData object containing a block of encoded MovieTag objects.

Parameters:

bytes - the encoded MovieTag objects.

MovieData

public MovieData(MovieData object)

Creates and initialises a MovieData object using the values copied from another MovieData object.

Parameters:

object - a MovieData object from which the values will be copied.

Method Detail

getData

public byte[] getData()

Get a copy the encoded MovieTag objects.

Returns:

a copy of the encoded objects.

copy

public MovieData 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.