org.apache.flex.compiler.internal.filespecs

Class SWCFileSpecification

java.lang.Object

org.apache.flex.compiler.internal.filespecs.SWCFileSpecification

All Implemented Interfaces:

IBinaryFileSpecification, IFileSpecification

public class SWCFileSpecification
extends Object
implements IBinaryFileSpecification

A SWCFileSpecification allows us to attach read a file from a SWC. This allows us to treat the SWC as one FileSpec

Constructor Summary

Constructors

Constructor and Description
SWCFileSpecification(String path, ISWCFileEntry fileEntry)

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	createInputStream()
Reader	createReader() Creates a new Reader for the contents of file.
long	getLastModified() Get the last modified timestamp of the file
String	getPath() Returns the path of the file.
boolean	isOpenDocument()

Methods inherited from class java.lang.Object

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

Constructor Detail

SWCFileSpecification

public SWCFileSpecification(String path,
                    ISWCFileEntry fileEntry)

Parameters:

path - Filename contained within the manifest.

fileEntry - ISWCFileEntry within the SWC. May be null if the file does not exist within the SWC. FileNotFound exception will be thrown if this IFileSpecification is read

Method Detail

getPath

public String getPath()

Description copied from interface: IFileSpecification

Returns the path of the file.

Specified by:

getPath in interface IFileSpecification

Returns:

The path of the file.

createReader

public Reader createReader()
                    throws FileNotFoundException

Description copied from interface: IFileSpecification

Creates a new Reader for the contents of file. Important: The caller should call Reader.close() when it is done reading.

Specified by:

createReader in interface IFileSpecification

Returns:

a Reader for the contents of the file.

Throws:

FileNotFoundException

getLastModified

public long getLastModified()

Description copied from interface: IFileSpecification

Get the last modified timestamp of the file

Specified by:

getLastModified in interface IFileSpecification

Returns:

the last modified timestamp

isOpenDocument

public boolean isOpenDocument()

Specified by:

isOpenDocument in interface IFileSpecification

Returns:

true if this file specification refers to an open document and the IFileSpecification.createReader() method returns a reader that reads the live document buffer.

createInputStream

public InputStream createInputStream()
                              throws IOException

Specified by:

createInputStream in interface IBinaryFileSpecification

Throws:

IOException