javax.tools

Interface FileObject

public interface FileObject

Abstraction for all kinds of file objects used by tools, e.g. regular files, memory cache, or database data.

Since:

1.6

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete() Deletes this file object.
java.lang.CharSequence	getCharContent(boolean ignoreEncodingErrors) Returns the character content of the file, if available.
long	getLastModified() Returns the time when the file was last modified.
java.lang.String	getName() Returns a name for this file object.
java.io.InputStream	openInputStream() Opens this file for reading and returns an input stream.
java.io.OutputStream	openOutputStream() Opens this file for writing and returns an output stream.
java.io.Reader	openReader(boolean ignoreEncodingErrors) Opens this file for reading and returns a reader.
java.io.Writer	openWriter() Opens this file for writer and returns a writer.
java.net.URI	toUri() Returns a URI that represents this file object.

Method Detail

toUri

java.net.URI toUri()

Returns a URI that represents this file object.

Returns:

a URI that represents this file object

getName

java.lang.String getName()

Returns a name for this file object. The exact name is implementation dependent.

Returns:

a name for this file object

openInputStream

java.io.InputStream openInputStream()
                                    throws java.io.IOException

Opens this file for reading and returns an input stream.

Returns:

an input stream to read this file object

Throws:

java.io.IOException - if an I/O error occured

java.lang.IllegalStateException - if this file was opened for writing and does not support reading

java.lang.UnsupportedOperationException - if this kind of file does not allow byte reading

openOutputStream

java.io.OutputStream openOutputStream()
                                      throws java.io.IOException

Opens this file for writing and returns an output stream.

Returns:

an output stream for writing this file object

Throws:

java.io.IOException - if an I/O error occurs

java.lang.IllegalStateException - if this file was opened for reading and does not support writing

java.lang.UnsupportedOperationException - if this kind of file does not allow byte writing

openReader

java.io.Reader openReader(boolean ignoreEncodingErrors)
                          throws java.io.IOException

Opens this file for reading and returns a reader.

Parameters:

ignoreEncodingErrors - true when encoding errors should be ignored false otherwise

Returns:

a reader for reading this file object

Throws:

java.io.IOException - if an I/O error occurs

java.lang.IllegalStateException - if this file was opened for writing and does not support reading

java.lang.UnsupportedOperationException - if this kind of file does not allow character reading

getCharContent

java.lang.CharSequence getCharContent(boolean ignoreEncodingErrors)
                                      throws java.io.IOException

Returns the character content of the file, if available. Any byte that cannot be decoded will be replaced by the default replacement character. A diagnostic may be reported, unless ignoreEncodingErrors is true.

Parameters:

ignoreEncodingErrors - true when encoding errors should be ignored false otherwise

Returns:

the character content, or null if not available

Throws:

java.io.IOException - if an I/O error occurs

openWriter

java.io.Writer openWriter()
                          throws java.io.IOException

Opens this file for writer and returns a writer.

Returns:

a writer for writing this file object

Throws:

java.io.IOException - if an I/O error occurs

java.lang.IllegalStateException - if this file was opened for reading and does not support writing

java.lang.UnsupportedOperationException - if this kind of file does not allow character writing

getLastModified

long getLastModified()

Returns the time when the file was last modified. The time is measured like in System.currentTimeMillis().

Returns:

the time when the file was last modified

delete

boolean delete()

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

Returns:

true when the file deletion was successful, false otherwise