org.apache.flex.compiler.filespecs

Class CombinedFile

java.lang.Object

org.apache.flex.compiler.filespecs.CombinedFile

All Implemented Interfaces:

IFileSpecification

public class CombinedFile
extends Object
implements IFileSpecification

This is an IFileSpecification that include multiple source files into one. JFlex-generated tokenizers can skip BOM at the beginning of a file, but not elsewhere. This class skips BOM header in each source file so that the merged file won't have a BOM in the middle of a file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CombinedFile.BOM BOM patterns.

Constructor Summary

Constructors

Constructor and Description
CombinedFile(List<String> includedFilenames, String sourceFilename) Create a combined file by concatenating includedFilenames together and append sourceFilename at the end.

Method Summary

Methods

Modifier and Type	Method and Description
Reader	createReader() Create a Reader from the combined source text.
static CombinedFile.BOM	getBOM(BufferedInputStream strm) Get the BOM tag of a stream.
long	getLastModified() Get the time stamp of the most recent modified file among the source files.
String	getPath() The path of the combined file is the path of the source file.
static BufferedInputStream	getStreamAndSkipBOM(String filename) Get the BufferedInputStream of a file, skipping the BOM.
boolean	isOpenDocument() Always return false because the combined file is cached in memory.

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedFile

public CombinedFile(List<String> includedFilenames,
            String sourceFilename)

Create a combined file by concatenating includedFilenames together and append sourceFilename at the end.

Parameters:

includedFilenames - included files

sourceFilename - source file

Method Detail

getPath

public String getPath()

The path of the combined file is the path of the source file.

Specified by:

getPath in interface IFileSpecification

Returns:

The path of the file.

createReader

public Reader createReader()
                    throws FileNotFoundException

Create a Reader from the combined source text.

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()

Get the time stamp of the most recent modified file among the source files.

Get the last modified timestamp of the file

Specified by:

getLastModified in interface IFileSpecification

Returns:

the last modified timestamp

isOpenDocument

public boolean isOpenDocument()

Always return false because the combined file is cached in memory.

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.

getStreamAndSkipBOM

public static BufferedInputStream getStreamAndSkipBOM(String filename)
                                               throws IOException

Get the BufferedInputStream of a file, skipping the BOM.

Parameters:

filename - The path to the file.

Returns:

BufferedInputStream

Throws:

IOException

getBOM

public static CombinedFile.BOM getBOM(BufferedInputStream strm)
                               throws IOException

Get the BOM tag of a stream.

Parameters:

strm - BufferedInputStream to be checked.

Returns:

CombinedFile.BOM type.

Throws:

IOException - Error.