javax.tools
Class ForwardingFileObject<F extends FileObject>

java.lang.Object
  javax.tools.ForwardingFileObject<F>

Type Parameters:

F - the kind of file object forwarded to by this object

All Implemented Interfaces:

FileObject

Direct Known Subclasses:

ForwardingJavaFileObject

public class ForwardingFileObject<F extends FileObject>
extends java.lang.Object
implements FileObject

Forwards calls to a given file object. Subclasses of this class might override some of these methods and might also provide additional fields and methods.

Since:

1.6

Author:

Peter von der Ahé

Field Summary

protected F

fileObject The file object which all methods are delegated to.

Constructor Summary

protected

ForwardingFileObject(F fileObject) Creates a new instance of ForwardingFileObject.

Method Summary

boolean	delete() Deletes this file object.
java.lang.CharSequence	getCharContent(boolean ignoreEncodingErrors) Gets the character content of this file object, if available.
long	getLastModified() Gets the time this file object was last modified.
java.lang.String	getName() Gets a user-friendly name for this file object.
java.io.InputStream	openInputStream() Gets an InputStream for this file object.
java.io.OutputStream	openOutputStream() Gets an OutputStream for this file object.
java.io.Reader	openReader(boolean ignoreEncodingErrors) Gets a reader for this object.
java.io.Writer	openWriter() Gets a Writer for this file object.
java.net.URI	toUri() Returns a URI identifying this file object.

Methods inherited from class java.lang.Object

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

Field Detail

fileObject

protected final F extends FileObject fileObject

The file object which all methods are delegated to.

Constructor Detail

ForwardingFileObject

protected ForwardingFileObject(F fileObject)

Creates a new instance of ForwardingFileObject.

Parameters:

fileObject - delegate to this file object

Method Detail

toUri

public java.net.URI toUri()

Description copied from interface: FileObject

Returns a URI identifying this file object.

Specified by:

toUri in interface FileObject

Returns:

a URI

getName

public java.lang.String getName()

Description copied from interface: FileObject

Gets 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.

Specified by:

getName in interface FileObject

Returns:

a user-friendly name

openInputStream

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

Description copied from interface: FileObject

Gets an InputStream for this file object.

Specified by:

openInputStream in interface FileObject

Returns:

an InputStream

Throws:

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

java.lang.UnsupportedOperationException - if this kind of file object does not support byte access

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

openOutputStream

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

Description copied from interface: FileObject

Gets an OutputStream for this file object.

Specified by:

openOutputStream in interface FileObject

Returns:

an OutputStream

Throws:

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

java.lang.UnsupportedOperationException - if this kind of file object does not support byte access

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

openReader

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

Description copied from interface: FileObject

Gets 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.

Specified by:

openReader in interface FileObject

Parameters:

ignoreEncodingErrors - ignore encoding errors if true

Returns:

a Reader

Throws:

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

java.lang.UnsupportedOperationException - if this kind of file object does not support character access

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

getCharContent

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

Description copied from interface: FileObject

Gets 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.

Specified by:

getCharContent in interface FileObject

Parameters:

ignoreEncodingErrors - ignore encoding errors if true

Returns:

a CharSequence if available; null otherwise

Throws:

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

java.lang.UnsupportedOperationException - if this kind of file object does not support character access

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

openWriter

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

Description copied from interface: FileObject

Gets a Writer for this file object.

Specified by:

openWriter in interface FileObject

Returns:

a Writer

Throws:

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

java.lang.UnsupportedOperationException - if this kind of file object does not support character access

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

getLastModified

public long getLastModified()

Description copied from interface: FileObject

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

Specified by:

getLastModified in interface FileObject

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

delete

public boolean delete()

Description copied from interface: FileObject

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

Specified by:

delete in interface FileObject

Returns:

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