org.apache.flex.compiler.internal.filespecs

Class ZipFileSpecification

java.lang.Object

org.apache.flex.compiler.internal.filespecs.ZipFileSpecification

All Implemented Interfaces:

Closeable, AutoCloseable, IFileSpecification, IZipFileSpecification

public class ZipFileSpecification
extends Object
implements IZipFileSpecification

Constructor Summary

Constructors

Constructor and Description
ZipFileSpecification(File file)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this archive
Reader	createReader() Creates a new Reader for the contents of file.
Iterator<String>	getEntries() Returns an iterator to the names of all the entries in this zip file
InputStream	getEntryStream(String name) Creates a stream to a given entry within the SWC file
long	getLastModified() Get the last modified timestamp of the file
String	getPath() Returns the path of the file.
boolean	hasEntry(String entryName) Determines if the given entry exists within this archive
boolean	isOpenDocument()

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFileSpecification

public ZipFileSpecification(File file)
                     throws ZipException,
                            IOException

Throws:

ZipException

IOException

Method Detail

getEntries

public Iterator<String> getEntries()

Description copied from interface: IZipFileSpecification

Returns an iterator to the names of all the entries in this zip file

Specified by:

getEntries in interface IZipFileSpecification

Returns:

an Iterator

getEntryStream

public InputStream getEntryStream(String name)
                           throws IOException

Description copied from interface: IZipFileSpecification

Creates a stream to a given entry within the SWC file

Specified by:

getEntryStream in interface IZipFileSpecification

Parameters:

name - the name of the entry we want

Returns:

an InputStream or null

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: IZipFileSpecification

Closes this archive

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IZipFileSpecification

Throws:

IOException

hasEntry

public boolean hasEntry(String entryName)

Description copied from interface: IZipFileSpecification

Determines if the given entry exists within this archive

Specified by:

hasEntry in interface IZipFileSpecification

Parameters:

entryName - the name of the entry

Returns:

true if it exists

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

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.

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.