org.apache.flex.swc

Class SWCLibrary

java.lang.Object

org.apache.flex.swc.SWCLibrary

All Implemented Interfaces:

ISWCLibrary

public class SWCLibrary
extends Object
implements ISWCLibrary

Implementation of library model in a SWC.

Constructor Summary

Constructors

Constructor and Description
SWCLibrary(String path) Use this constructor for reading a SWC library.
SWCLibrary(String path, ISWF swf) Use this constructor for writing a SWC library.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDigest(ISWCDigest digest) Add a new digest to the library.
void	addNameToKeepAS3MetadataSet(String name) Adds a metadata name to appear in the <keep-as3-metadata> tag.
void	addScript(ISWCScript script) Add an ISWCScript to the library.
List<ISWCDigest>	getDigests() Get the digests of the library.
Set<String>	getKeepAS3MetadataSet() Gets all the metadata names in the <keep-as3-metadata> tag.
String	getPath() Get the path of the library SWF file.
ISWCScript	getScript(String name) Get script by name.
List<ISWCScript>	getScripts() Get all the IScript objects in this library.
ISWF	getSWF() Get the SWF model for the library.
void	readSWFInputStream(SWFReader swfReader, ISWC swc) Read the InputStream of the library SWF file.
void	removeDigest(ISWCDigest digest) Remove an existing digest from the library.
String	toString() For debugging only.

Methods inherited from class java.lang.Object

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

Constructor Detail

SWCLibrary

public SWCLibrary(String path,
          ISWF swf)

Use this constructor for writing a SWC library.

Parameters:

path - relative path of the library in the SWC archive

swf - model for the library SWF

SWCLibrary

public SWCLibrary(String path)

Use this constructor for reading a SWC library.

Parameters:

path - relative path of the library in the SWC archive

Method Detail

addScript

public void addScript(ISWCScript script)

Description copied from interface: ISWCLibrary

Add an ISWCScript to the library.

Specified by:

addScript in interface ISWCLibrary

Parameters:

script - IScript object

getPath

public String getPath()

Description copied from interface: ISWCLibrary

Get the path of the library SWF file.

Specified by:

getPath in interface ISWCLibrary

Returns:

relative path of the SWF file

getScripts

public List<ISWCScript> getScripts()

Description copied from interface: ISWCLibrary

Get all the IScript objects in this library.

Specified by:

getScripts in interface ISWCLibrary

Returns:

list of scripts

getKeepAS3MetadataSet

public Set<String> getKeepAS3MetadataSet()

Description copied from interface: ISWCLibrary

Gets all the metadata names in the <keep-as3-metadata> tag.

Specified by:

getKeepAS3MetadataSet in interface ISWCLibrary

Returns:

metadata name list

addNameToKeepAS3MetadataSet

public void addNameToKeepAS3MetadataSet(String name)

Description copied from interface: ISWCLibrary

Adds a metadata name to appear in the <keep-as3-metadata> tag.

Specified by:

addNameToKeepAS3MetadataSet in interface ISWCLibrary

Parameters:

name - A metadata name, like "Bindable".

readSWFInputStream

public void readSWFInputStream(SWFReader swfReader,
                      ISWC swc)

Description copied from interface: ISWCLibrary

Read the InputStream of the library SWF file.

Specified by:

readSWFInputStream in interface ISWCLibrary

Parameters:

swfReader - containing SWFReader object

swc - containing ISWC object

getScript

public ISWCScript getScript(String name)

Description copied from interface: ISWCLibrary

Get script by name.

Specified by:

getScript in interface ISWCLibrary

Parameters:

name - script name

Returns:

script

getDigests

public List<ISWCDigest> getDigests()

Description copied from interface: ISWCLibrary

Get the digests of the library.

Specified by:

getDigests in interface ISWCLibrary

Returns:

a list of digest information

getSWF

public ISWF getSWF()

Description copied from interface: ISWCLibrary

Get the SWF model for the library.

Specified by:

getSWF in interface ISWCLibrary

Returns:

null or library SWF model

addDigest

public void addDigest(ISWCDigest digest)

Add a new digest to the library.

Specified by:

addDigest in interface ISWCLibrary

Parameters:

digest - The digest to add. May not be null.

removeDigest

public void removeDigest(ISWCDigest digest)

Remove an existing digest from the library.

Parameters:

digest - The digest to add. May not be null.

toString

public String toString()

For debugging only.

Overrides:

toString in class Object