com.flagstone.transform
Class SerialNumber

java.lang.Object
  com.flagstone.transform.SerialNumber

All Implemented Interfaces:

Copyable<MovieTag>, SWFEncodeable, MovieTag

public final class SerialNumber
extends Object
implements MovieTag

SerialNumber is used to add a user-defined serial number into a Flash file.

Constructor Summary

SerialNumber(SerialNumber object)
Creates and initialises a SerialNumber object using the number copied from another SerialNumber object.

SerialNumber(String aString)
Creates a SerialNumber action with the specified string.

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

Method Summary

SerialNumber	copy() Creates a complete copy of this object.
void	encode(SWFEncoder coder, Context context) Encode an object to the Flash binary format.
String	getNumber() Get the serial number.
int	prepareToEncode(Context context) Prepare an object for encoding, returning the expected size of an object when it is encoded.
void	setNumber(String aString) Sets the serial number.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialNumber

public SerialNumber(SWFDecoder coder)
             throws IOException

Creates and initialises a SerialNumber 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.

SerialNumber

public SerialNumber(String aString)

Creates a SerialNumber action with the specified string.

Parameters:

aString - an arbitrary string containing the serial number. Must not be null.

SerialNumber

public SerialNumber(SerialNumber object)

Creates and initialises a SerialNumber object using the number copied from another SerialNumber object.

Parameters:

object - a SerialNumber object from which the serial number will be copied.

Method Detail

getNumber

public String getNumber()

Get the serial number.

Returns:

the string used to identify the movie.

setNumber

public void setNumber(String aString)

Sets the serial number.

Parameters:

aString - an arbitrary string containing the serial number. Must not be null.

copy

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