org.apache.flex.swc.io

Class SWCReader

java.lang.Object

org.apache.flex.swc.io.SWCReader

All Implemented Interfaces:

ISWCReader

public class SWCReader
extends Object
implements ISWCReader

Read a SWC file using Java ZIP utilities. The SWCReader owns the result ISWC object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATALOG_XML

Constructor Summary

Constructors

Constructor and Description
SWCReader(File swcFile) Create a SWCReader from a file object
SWCReader(File swcFile, IPackageDITAParser packageDitaParser) Create a SWCReader from a file object
SWCReader(String filename) Create a SWCReader from a file path.

Method Summary

Methods

Modifier and Type	Method and Description
File	getFile() Get the file handler of the SWC file.
static InputStream	getInputStream(ZipFile zipFile, String filename) Get the InputStream of a file in the SWC archive.
static String	getReportingPath(String swcPath, String libraryPath) Create a single path that is a combined path of the SWC and the library inside.
ISWC	getSWC() Get the SWC model object.

Methods inherited from class java.lang.Object

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

Field Detail

CATALOG_XML

public static final String CATALOG_XML

See Also:

Constant Field Values

Constructor Detail

SWCReader

public SWCReader(String filename)

Create a SWCReader from a file path.

Parameters:

filename - file path

SWCReader

public SWCReader(File swcFile)

Create a SWCReader from a file object

Parameters:

swcFile - input SWC file. The file must exist or a FileNotFoundException is thrown.

SWCReader

public SWCReader(File swcFile,
         IPackageDITAParser packageDitaParser)

Create a SWCReader from a file object

Parameters:

swcFile - input SWC file. The file must exist or a FileNotFoundException is thrown.

packageDitaParser - IPackageDITAParser that will be used to parse DITA information found in the SWC.

Method Detail

getFile

public File getFile()

Description copied from interface: ISWCReader

Get the file handler of the SWC file.

Specified by:

getFile in interface ISWCReader

Returns:

SWC file object

getSWC

public ISWC getSWC()

Description copied from interface: ISWCReader

Get the SWC model object.

Specified by:

getSWC in interface ISWCReader

Returns:

ISWC object

getInputStream

public static InputStream getInputStream(ZipFile zipFile,
                         String filename)
                                  throws IOException

Get the InputStream of a file in the SWC archive. If the file does not exist in the zip file, return null.

Parameters:

zipFile - Zip file.

filename - Name of the file in the zip archive.

Returns:

InputStream of the file in the zip archive, or null.

Throws:

IOException - Error reading file from zip archive.

getReportingPath

public static String getReportingPath(String swcPath,
                      String libraryPath)

Create a single path that is a combined path of the SWC and the library inside. This path should only be used for error reporting. It should not be used to open the file.

Parameters:

swcPath - the path of the SWC.

libraryPath - the path of the library withing the SWC.

Returns:

combined path for SWC and library file.