flex2.compiler.io

Interface VirtualFile

All Superinterfaces:

SinglePathResolver

All Known Implementing Classes:

LocalFile, NetworkFile, VirtualLocalFile

public interface VirtualFile
extends SinglePathResolver

Defines the API to by used by all virtual files.

Author:

Clement Wong

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Signal the hosting environment that this instance is no longer used.
boolean	equals(Object object) Override equals().
InputStream	getInputStream() Return input stream...
long	getLastModified() Return last time the underlying source is modified.
String	getMimeType() Return mime type
String	getName() Return name...
String	getNameForReporting() Return the name to be used when reporting errors or warnings.
String	getParent()
String	getURL() Return an URL string of this file
int	hashCode() Override hashCode().
boolean	isDirectory()
boolean	isTextBased() Return true if it's text-based. toString() returns the text
long	size() Return file size...
byte[]	toByteArray() Return the entire content in byte[]

Methods inherited from interface flex2.compiler.common.SinglePathResolver

resolve

Method Detail

getName

String getName()

Return name... It could be canonical path name, URL, etc. But it must be unique among all the files processed by the compiler... The compiler should not use this to get... e.g. parent path... There is no guarantee that this returns a pathname even though the underlying implementation deals with files...

getNameForReporting

String getNameForReporting()

Return the name to be used when reporting errors or warnings.

getURL

String getURL()

Return an URL string of this file

getParent

String getParent()

isDirectory

boolean isDirectory()

size

long size()

Return file size...

getMimeType

String getMimeType()

Return mime type

getInputStream

InputStream getInputStream()
                           throws IOException

Return input stream...

Throws:

IOException

toByteArray

byte[] toByteArray()
                   throws IOException

Return the entire content in byte[]

Throws:

IOException

isTextBased

boolean isTextBased()

Return true if it's text-based. toString() returns the text

getLastModified

long getLastModified()

Return last time the underlying source is modified.

close

void close()

Signal the hosting environment that this instance is no longer used.

equals

boolean equals(Object object)

Override equals(). Instances of VirtualFile can be used as keys.

Overrides:

equals in class Object

hashCode

int hashCode()

Override hashCode(). Instances of VirtualFile can be used as keys.

Overrides:

hashCode in class Object