APIdia Launch Partner
Top Description Methods
javax.tools

public Interface FileObject

Known Direct Subinterfaces
javax.tools.JavaFileObject
Known Direct Implementers
javax.tools.ForwardingFileObject
Imports
java.io.IOException, .InputStream, .OutputStream, .Reader, .Writer, java.net.URI
File abstraction for tools. In this context, file means an abstraction of regular files and other sources of data. For example, a file object can be used to represent regular files, memory cache, or data in databases.

Unless explicitly allowed, all methods in this interface might throw a NullPointerException if given a null argument.

Since
1.6

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if and only if this file object is successfully deleted; false otherwise
delete()

Deletes this file object.

public CharSequence

Returns:

a CharSequence if available; null otherwise
getCharContent(boolean
ignore encoding errors if true
ignoreEncodingErrors)

Returns the character content of this file object, if available.

public long

Returns:

the time this file object was last modified; or 0 if the file object does not exist, if an I/O error occurred, or if the operation is not supported
getLastModified()

Returns the time this file object was last modified.

public String

Returns:

a user-friendly name
getName()

Returns a user-friendly name for this file object.

public InputStream

Returns:

an InputStream
openInputStream()

Returns an InputStream for this file object.

public OutputStream

Returns:

an OutputStream
openOutputStream()

Returns an OutputStream for this file object.

public Reader

Returns:

a Reader
openReader(boolean
ignore encoding errors if true
ignoreEncodingErrors)

Returns a reader for this object.

public Writer

Returns:

a Writer
openWriter()

Returns a Writer for this file object.

public URI

Returns:

a URI
toUri()

Returns a URI identifying this file object.

Method Detail

deleteback to summary
public boolean delete()

Deletes this file object. In case of errors, returns false.

Returns:boolean

true if and only if this file object is successfully deleted; false otherwise

getCharContentback to summary
public CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException

Returns the character content of this file object, if available. Any byte that cannot be decoded will be replaced by the default translation character. In addition, a diagnostic may be reported unless ignoreEncodingErrors is true.

Parameters
ignoreEncodingErrors:boolean

ignore encoding errors if true

Returns:CharSequence

a CharSequence if available; null otherwise

Exceptions
IOException:
if an I/O error occurred
IllegalStateException:
if this file object was opened for writing and does not support reading
UnsupportedOperationException:
if this kind of file object does not support character access
getLastModifiedback to summary
public long getLastModified()

Returns the time this file object was last modified. The time is measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970).

Returns:long

the time this file object was last modified; or 0 if the file object does not exist, if an I/O error occurred, or if the operation is not supported

getNameback to summary
public String getName()

Returns a user-friendly name for this file object. The exact value returned is not specified but implementations should take care to preserve names as given by the user. For example, if the user writes the filename "BobsApp\Test.java" on the command line, this method should return "BobsApp\Test.java" whereas the toUri method might return file:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java.

Returns:String

a user-friendly name

openInputStreamback to summary
public InputStream openInputStream() throws IOException

Returns an InputStream for this file object.

Returns:InputStream

an InputStream

Exceptions
IOException:
if an I/O error occurred
IllegalStateException:
if this file object was opened for writing and does not support reading
UnsupportedOperationException:
if this kind of file object does not support byte access
openOutputStreamback to summary
public OutputStream openOutputStream() throws IOException

Returns an OutputStream for this file object.

Returns:OutputStream

an OutputStream

Exceptions
IOException:
if an I/O error occurred
IllegalStateException:
if this file object was opened for reading and does not support writing
UnsupportedOperationException:
if this kind of file object does not support byte access
openReaderback to summary
public Reader openReader(boolean ignoreEncodingErrors) throws IOException

Returns a reader for this object. The returned reader will replace bytes that cannot be decoded with the default translation character. In addition, the reader may report a diagnostic unless ignoreEncodingErrors is true.

Parameters
ignoreEncodingErrors:boolean

ignore encoding errors if true

Returns:Reader

a Reader

Exceptions
IOException:
if an I/O error occurred
IllegalStateException:
if this file object was opened for writing and does not support reading
UnsupportedOperationException:
if this kind of file object does not support character access
openWriterback to summary
public Writer openWriter() throws IOException

Returns a Writer for this file object.

Returns:Writer

a Writer

Exceptions
IOException:
if an I/O error occurred
IllegalStateException:
if this file object was opened for reading and does not support writing
UnsupportedOperationException:
if this kind of file object does not support character access
toUriback to summary
public URI toUri()

Returns a URI identifying this file object.

Returns:URI

a URI