org.apache.flex.swc.io

Class SWCWriter

java.lang.Object

org.apache.flex.swc.io.SWCWriter

All Implemented Interfaces:

ISWCWriter

public class SWCWriter
extends Object

Implementation for serializing a SWC model to a *.swc library file.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CATALOG_XML File name of "catalog.xml".
protected boolean	enableDebug
protected boolean	enableTelemetry
protected ISWFWriterFactory	swfWriterFactory

Constructor Summary

Constructors

Constructor and Description
SWCWriter(String filename) Create a SWC where the library.swf is build with debug and is compressed.
SWCWriter(String filename, boolean compressLibrarySWF, boolean enableDebug, boolean enableTelemetry, ISWFWriterFactory swfWriterFactory)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDigestToLibrary(DigestOutputStream digestStream, ISWCLibrary library) Add the digest from the digestStream to the ISWCLibrary.
boolean	compressLibrarySWF()
protected DigestOutputStream	getDigestOutputStream(ISWCLibrary library, OutputStream outputStream) Get a digest stream output if the library needs to create a digest for the library.swf.
Header.Compression	getLibrarySWFCompression()
void	write(ISWC swc) This method defines the serialization order.
protected void	writeCatalogXML(ISWC swc, Writer writer) Serialize the SWC model's catalog.xml to a writer.

Methods inherited from class java.lang.Object

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

Field Detail

CATALOG_XML

protected static final String CATALOG_XML

File name of "catalog.xml".

See Also:

Constant Field Values

enableDebug

protected final boolean enableDebug

enableTelemetry

protected final boolean enableTelemetry

swfWriterFactory

protected final ISWFWriterFactory swfWriterFactory

Constructor Detail

SWCWriter

public SWCWriter(String filename)
          throws FileNotFoundException

Create a SWC where the library.swf is build with debug and is compressed.

Parameters:

filename - path to write the file to.

Throws:

FileNotFoundException

SWCWriter

public SWCWriter(String filename,
         boolean compressLibrarySWF,
         boolean enableDebug,
         boolean enableTelemetry,
         ISWFWriterFactory swfWriterFactory)
          throws FileNotFoundException

Parameters:

filename - path to write the file to.

compressLibrarySWF - - true if the library will be built compressed, false otherwise.

enableDebug - - true if the library should be build with debug enabled, false otherwise.

swfWriterFactory - - factory for creating swf writers.

Throws:

FileNotFoundException

Method Detail

compressLibrarySWF

public boolean compressLibrarySWF()

Returns:

true if the library is built compressed, false otherwise.

getLibrarySWFCompression

public Header.Compression getLibrarySWFCompression()

write

public void write(ISWC swc)
           throws IOException

This method defines the serialization order.

Specified by:

write in interface ISWCWriter

Parameters:

swc - SWC model

Throws:

IOException - error

writeCatalogXML

protected final void writeCatalogXML(ISWC swc,
                   Writer writer)

Serialize the SWC model's catalog.xml to a writer.

Parameters:

swc - model

getDigestOutputStream

protected DigestOutputStream getDigestOutputStream(ISWCLibrary library,
                                       OutputStream outputStream)

Get a digest stream output if the library needs to create a digest for the library.swf.

Parameters:

library -

Returns:

a digest stream if a digest is needed, null otherwise.

addDigestToLibrary

protected void addDigestToLibrary(DigestOutputStream digestStream,
                      ISWCLibrary library)

Add the digest from the digestStream to the ISWCLibrary.

Parameters:

digestStream - may be null. If null no digest is created.

library - The library to update. May not be null.

Throws:

NullPointerException - if library is null.