org.apache.flex.swc

Class SWC

java.lang.Object

org.apache.flex.swc.SWC

All Implemented Interfaces:

ISWC

public class SWC
extends Object
implements ISWC

Implementation of ISWC. It contains the in-memory model of a SWC file. TODO Use ZipFileSpecification as the implementation

Constructor Summary

Constructors

Constructor and Description
SWC(File file) Use this constructor for reading or writing a SWC.

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponent(ISWCComponent component)
void	addFile(ISWCFileEntry file)
void	addFile(String path, long mod, byte[] contentByteArray) Add a file that will be written into swc file during creation.
void	addLibrary(ISWCLibrary library)
void	addProblem(ICompilerProblem problem) Record a problem encountered while reading or writing the SWC.
List<ISWCComponent>	getComponents() Get the manifest information.
IDITAList	getDITAList() Get the IDITAList for any DITA entries contained in this SWC
ISWCFileEntry	getFile(String filename) Get the asset information encoded in the file tags for the specific filename
Map<String,ISWCFileEntry>	getFiles() Get the assets information encoded in the file tags.
Collection<ISWCLibrary>	getLibraries() Get the SWF libraries.
ISWCLibrary	getLibrary(String libraryPath) Get a library entry by path.
Collection<ICompilerProblem>	getProblems() The problems found while reading a SWC from disk or writing a SWC to disk.
File	getSWCFile() Get the SWC file object.
ISWCVersion	getVersion() Get the SWC version information.
boolean	isANE() Determine whether this SWC is an ANE file.
void	setDITAList(IDITAList list)
void	setIsANE(boolean isANE) Set whether this SWC is an ANE file or not.
String	toString() For debugging only.

Methods inherited from class java.lang.Object

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

Constructor Detail

SWC

public SWC(File file)

Use this constructor for reading or writing a SWC. The file handle is the SWC file.

Parameters:

file - SWC file object

Method Detail

addComponent

public void addComponent(ISWCComponent component)

addLibrary

public void addLibrary(ISWCLibrary library)

addFile

public void addFile(ISWCFileEntry file)

addFile

public void addFile(String path,
           long mod,
           byte[] contentByteArray)

Add a file that will be written into swc file during creation.

Parameters:

path - destination path of the file relative to the root of swc.

mod - last modified date for the file

contentByteArray - byte array representing the content of the file to write.

setDITAList

public void setDITAList(IDITAList list)

setIsANE

public void setIsANE(boolean isANE)

Set whether this SWC is an ANE file or not.

Parameters:

isANE - true if this SWC is an ANE file, false otherwise.

getComponents

public List<ISWCComponent> getComponents()

Description copied from interface: ISWC

Get the manifest information.

Specified by:

getComponents in interface ISWC

Returns:

manifest information

getLibraries

public Collection<ISWCLibrary> getLibraries()

Description copied from interface: ISWC

Get the SWF libraries. For example: library.swf.

Specified by:

getLibraries in interface ISWC

Returns:

libraries

getLibrary

public ISWCLibrary getLibrary(String libraryPath)

Description copied from interface: ISWC

Get a library entry by path.

Specified by:

getLibrary in interface ISWC

Parameters:

libraryPath - The path of a library. For exmaple: library.swf.

Returns:

libraries

getVersion

public ISWCVersion getVersion()

Description copied from interface: ISWC

Get the SWC version information.

Specified by:

getVersion in interface ISWC

Returns:

version

getFiles

public Map<String,ISWCFileEntry> getFiles()

Description copied from interface: ISWC

Get the assets information encoded in the file tags.

Specified by:

getFiles in interface ISWC

Returns:

assets

getFile

public ISWCFileEntry getFile(String filename)

Description copied from interface: ISWC

Get the asset information encoded in the file tags for the specific filename

Specified by:

getFile in interface ISWC

Parameters:

filename - The filename to search for in the swc

Returns:

ISWCFileEntry for the filename, or null if not contained within the SWC

getSWCFile

public File getSWCFile()

Description copied from interface: ISWC

Get the SWC file object.

Specified by:

getSWCFile in interface ISWC

Returns:

file object

getDITAList

public IDITAList getDITAList()

Description copied from interface: ISWC

Get the IDITAList for any DITA entries contained in this SWC

Specified by:

getDITAList in interface ISWC

Returns:

an IDITAList or null if this SWC dosn't contain DITA content

isANE

public boolean isANE()

Description copied from interface: ISWC

Determine whether this SWC is an ANE file.

Specified by:

isANE in interface ISWC

Returns:

true if the this SWC is an ANE file, false otherwise.

toString

public String toString()

For debugging only.

Overrides:

toString in class Object

getProblems

public Collection<ICompilerProblem> getProblems()

Description copied from interface: ISWC

The problems found while reading a SWC from disk or writing a SWC to disk.

Specified by:

getProblems in interface ISWC

Returns:

a collection of problems.

addProblem

public void addProblem(ICompilerProblem problem)

Record a problem encountered while reading or writing the SWC.

Parameters:

problem - the compiler problem to add to this SWC.