Java™ Platform
Standard Ed. 6

javax.tools
Class SimpleJavaFileObject

java.lang.Object
  extended by javax.tools.SimpleJavaFileObject
All Implemented Interfaces:
FileObject, JavaFileObject

public class SimpleJavaFileObject
extends Object
implements JavaFileObject

Provides simple implementations for most methods in JavaFileObject. This class is designed to be subclassed and used as a basis for JavaFileObject implementations. Subclasses can override the implementation and specification of any method of this class as long as the general contract of JavaFileObject is obeyed.

Since:
1.6

Nested Class Summary
 
Nested classes/interfaces inherited from interface javax.tools.JavaFileObject
JavaFileObject.Kind
 
Field Summary
protected  JavaFileObject.Kind kind
          The kind of this file object.
protected  URI uri
          A URI for this file object.
 
Constructor Summary
protected SimpleJavaFileObject(URI uri, JavaFileObject.Kind kind)
          Construct a SimpleJavaFileObject of the given kind and with the given URI.
 
Method Summary
 boolean delete()
          This implementation does nothing.
 Modifier getAccessLevel()
          This implementation returns null.
 CharSequence getCharContent(boolean ignoreEncodingErrors)
          This implementation always throws UnsupportedOperationException.
 JavaFileObject.Kind getKind()
          Gets the kind of this file object.
 long getLastModified()
          This implementation returns 0L.
 String getName()
          Gets a user-friendly name for this file object.
 NestingKind getNestingKind()
          This implementation returns null.
 boolean isNameCompatible(String simpleName, JavaFileObject.Kind kind)
          This implementation compares the path of its URI to the given simple name.
 InputStream openInputStream()
          This implementation always throws UnsupportedOperationException.
 OutputStream openOutputStream()
          This implementation always throws UnsupportedOperationException.
 Reader openReader(boolean ignoreEncodingErrors)
          Wraps the result of getCharContent(boolean) in a Reader.
 Writer openWriter()
          Wraps the result of openOutputStream in a Writer.
 String toString()
          Returns a string representation of the object.
 URI toUri()
          Returns a URI identifying this file object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

uri

protected final URI uri
A URI for this file object.


kind

protected final JavaFileObject.Kind kind
The kind of this file object.

Constructor Detail

SimpleJavaFileObject

protected SimpleJavaFileObject(URI uri,
                               JavaFileObject.Kind kind)
Construct a SimpleJavaFileObject of the given kind and with the given URI.

Parameters:
uri - the URI for this file object
kind - the kind of this file object
Method Detail

toUri

public 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 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 InputStream openInputStream()
                            throws IOException
This implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract of FileObject is obeyed.

Specified by:
openInputStream in interface FileObject
Returns:
an InputStream
Throws:
IOException - if an I/O error occurred

openOutputStream

public OutputStream openOutputStream()
                              throws IOException
This implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract of FileObject is obeyed.

Specified by:
openOutputStream in interface FileObject
Returns:
an OutputStream
Throws:
IOException - if an I/O error occurred

openReader

public Reader openReader(boolean ignoreEncodingErrors)
                  throws IOException
Wraps the result of getCharContent(boolean) in a Reader. Subclasses can change this behavior as long as the contract of FileObject is obeyed.

Specified by:
openReader in interface FileObject
Parameters:
ignoreEncodingErrors - ignore encoding errors if true
Returns:
a Reader wrapping the result of getCharContent
Throws:
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
IOException - if an I/O error occurred

getCharContent

public CharSequence getCharContent(boolean ignoreEncodingErrors)
                            throws IOException
This implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract of FileObject is obeyed.

Specified by:
getCharContent in interface FileObject
Parameters:
ignoreEncodingErrors - ignore encoding errors if true
Returns:
a CharSequence if available; null otherwise
Throws:
IOException - if an I/O error occurred

openWriter

public Writer openWriter()
                  throws IOException
Wraps the result of openOutputStream in a Writer. Subclasses can change this behavior as long as the contract of FileObject is obeyed.

Specified by:
openWriter in interface FileObject
Returns:
a Writer wrapping the result of openOutputStream
Throws:
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
IOException - if an I/O error occurred

getLastModified

public long getLastModified()
This implementation returns 0L. Subclasses can change this behavior as long as the contract of FileObject is obeyed.

Specified by:
getLastModified in interface FileObject
Returns:
0L

delete

public boolean delete()
This implementation does nothing. Subclasses can change this behavior as long as the contract of FileObject is obeyed.

Specified by:
delete in interface FileObject
Returns:
false

getKind

public JavaFileObject.Kind getKind()
Description copied from interface: JavaFileObject
Gets the kind of this file object.

Specified by:
getKind in interface JavaFileObject
Returns:
this.kind

isNameCompatible

public boolean isNameCompatible(String simpleName,
                                JavaFileObject.Kind kind)
This implementation compares the path of its URI to the given simple name. This method returns true if the given kind is equal to the kind of this object, and if the path is equal to simpleName + kind.extension or if it ends with "/" + simpleName + kind.extension.

This method calls getKind() and toUri() and does not access the fields uri and kind directly.

Subclasses can change this behavior as long as the contract of JavaFileObject is obeyed.

Specified by:
isNameCompatible in interface JavaFileObject
Parameters:
simpleName - a simple name of a class
kind - a kind
Returns:
true if this file object is compatible; false otherwise

getNestingKind

public NestingKind getNestingKind()
This implementation returns null. Subclasses can change this behavior as long as the contract of JavaFileObject is obeyed.

Specified by:
getNestingKind in interface JavaFileObject
Returns:
the nesting kind, or null if the nesting kind is not known

getAccessLevel

public Modifier getAccessLevel()
This implementation returns null. Subclasses can change this behavior as long as the contract of JavaFileObject is obeyed.

Specified by:
getAccessLevel in interface JavaFileObject
Returns:
the access level

toString

public String toString()
Description copied from class: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:
toString in class Object
Returns:
a string representation of the object.

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.