flex2.tools.oem

Class VirtualLocalFile

java.lang.Object

flex2.tools.oem.VirtualLocalFile

All Implemented Interfaces:

SinglePathResolver, VirtualFile

public class VirtualLocalFile
extends Object
implements VirtualFile

The VirtualLocalFile class represents a source file in memory. Each VirtualLocalFile instance is given a parent that corresponds to a valid directory in the filesystem. Path resolution is done as if VirtualLocalFile instances represented real files in the filesystem.

You can not create an instance of the VirtualLocalFile class directly. You must use the VirtualLocalFileSystem class to create them.

Version:

2.0.1

Author:

Clement Wong

See Also:

VirtualLocalFileSystem

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this VirtualLocalFile object.
boolean	equals(Object obj) Compares this object with the specified object.
InputStream	getInputStream() Returns the text in this VirtualLocalFile object in an InputStream.
long	getLastModified() Gets the last modified time of this VirtualLocalFile object.
String	getMimeType() Returns The MIME type of this VirtualLocalFile object.
String	getName() Gets the name of this VirtualLocalFile object.
String	getNameForReporting() Gets the name of this VirtualLocalFile for error reporting.
String	getParent() Gets the parent directory path of this VirtualLocalFile object.
String	getURL() Throws an UnsupportedOperationException exception.
int	hashCode() Returns the hash code of this VirtualLocalFile object.
boolean	isDirectory() Returns true if this VirtualLocalFile object is a directory.
boolean	isTextBased() Returns true if the content of this VirtualLocalFile object is text based.
VirtualFile	resolve(String relativeStr) Resolves the specified relative path to a VirtualFile instance.
long	size() Returns the length of the text in this VirtualLocalFile object.
byte[]	toByteArray() Returns the text in this VirtualLocalFile object in an byte[].
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Gets the name of this VirtualLocalFile object. This is sually a canonical path.

Specified by:

getName in interface VirtualFile

Returns:

The name of this VirtualLocalFile object.

getNameForReporting

public String getNameForReporting()

Gets the name of this VirtualLocalFile for error reporting. This is usually a canonical path.

Specified by:

getNameForReporting in interface VirtualFile

Returns:

The name used when reporting warnings and errors.

See Also:

getName()

getURL

public String getURL()

Throws an UnsupportedOperationException exception.

Specified by:

getURL in interface VirtualFile

getParent

public String getParent()

Gets the parent directory path of this VirtualLocalFile object.

Specified by:

getParent in interface VirtualFile

Returns:

The parent's canonical path.

isDirectory

public boolean isDirectory()

Returns true if this VirtualLocalFile object is a directory. This method always returns false.

Specified by:

isDirectory in interface VirtualFile

Returns:

false.

size

public long size()

Returns the length of the text in this VirtualLocalFile object.

Specified by:

size in interface VirtualFile

Returns:

The length of the text.

getMimeType

public String getMimeType()

Returns The MIME type of this VirtualLocalFile object.

Specified by:

getMimeType in interface VirtualFile

Returns:

The MIME type.

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns the text in this VirtualLocalFile object in an InputStream. The text is converted into a byte stream based on UTF-8 encoding.

Specified by:

getInputStream in interface VirtualFile

Returns:

An InputStream.

Throws:

IOException - Thrown when an I/O error occurs.

toByteArray

public byte[] toByteArray()
                   throws IOException

Returns the text in this VirtualLocalFile object in an byte[].

Specified by:

toByteArray in interface VirtualFile

Throws:

IOException

getLastModified

public long getLastModified()

Gets the last modified time of this VirtualLocalFile object.

Specified by:

getLastModified in interface VirtualFile

Returns:

The last modified time.

resolve

public VirtualFile resolve(String relativeStr)

Resolves the specified relative path to a VirtualFile instance.

Specified by:

resolve in interface SinglePathResolver

Parameters:

relativeStr - The relative path to be resolved.

Returns:

If successful, a VirtualFile for relativeStr.

close

public void close()

Closes this VirtualLocalFile object. This method does nothing.

Specified by:

close in interface VirtualFile

equals

public boolean equals(Object obj)

Compares this object with the specified object.

Specified by:

equals in interface VirtualFile

Overrides:

equals in class Object

Parameters:

obj - An Object.

Returns:

true if obj == this.

hashCode

public int hashCode()

Returns the hash code of this VirtualLocalFile object.

Specified by:

hashCode in interface VirtualFile

Overrides:

hashCode in class Object

Returns:

The hashCode.

isTextBased

public boolean isTextBased()

Returns true if the content of this VirtualLocalFile object is text based. This method always returns true.

Specified by:

isTextBased in interface VirtualFile

Returns:

true.

toString

public String toString()

Overrides:

toString in class Object