SimpleJavaFileObject (Java Platform SE 6) (original) (raw)

javax.tools

Class SimpleJavaFileObject

java.lang.Object 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

uri

protected final URI uri

A URI for this file object.

kind

protected final JavaFileObject.Kind kind

The kind of this file object.

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

toUri

public URI toUri()

Description copied from interface: [FileObject](../../javax/tools/FileObject.html#toUri%28%29)

Returns a URI identifying this file object.

Specified by:

[toUri](../../javax/tools/FileObject.html#toUri%28%29) in interface [FileObject](../../javax/tools/FileObject.html "interface in javax.tools")

Returns:

a URI

getName

public String getName()

Description copied from interface: [FileObject](../../javax/tools/FileObject.html#getName%28%29)

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](../../javax/tools/FileObject.html#getName%28%29) in interface [FileObject](../../javax/tools/FileObject.html "interface in javax.tools")

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](../../javax/tools/FileObject.html#openInputStream%28%29) in interface [FileObject](../../javax/tools/FileObject.html "interface in javax.tools")

Returns:

an InputStream

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - 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](../../javax/tools/FileObject.html#openOutputStream%28%29) in interface [FileObject](../../javax/tools/FileObject.html "interface in javax.tools")

Returns:

an OutputStream

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - 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 ofFileObject is obeyed.

Specified by:

[openReader](../../javax/tools/FileObject.html#openReader%28boolean%29) in interface [FileObject](../../javax/tools/FileObject.html "interface in javax.tools")

Parameters:

ignoreEncodingErrors - ignore encoding errors if true

Returns:

a Reader wrapping the result of getCharContent

Throws:

[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang") - if this file object was opened for writing and does not support reading

[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang") - if this kind of file object does not support character access

[IOException](../../java/io/IOException.html "class in java.io") - 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](../../javax/tools/FileObject.html#getCharContent%28boolean%29) in interface [FileObject](../../javax/tools/FileObject.html "interface in javax.tools")

Parameters:

ignoreEncodingErrors - ignore encoding errors if true

Returns:

a CharSequence if available; null otherwise

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - 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](../../javax/tools/FileObject.html#openWriter%28%29) in interface [FileObject](../../javax/tools/FileObject.html "interface in javax.tools")

Returns:

a Writer wrapping the result of openOutputStream

Throws:

[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang") - if this file object was opened for reading and does not support writing

[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang") - if this kind of file object does not support character access

[IOException](../../java/io/IOException.html "class in java.io") - 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](../../javax/tools/FileObject.html#getLastModified%28%29) in interface [FileObject](../../javax/tools/FileObject.html "interface in javax.tools")

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](../../javax/tools/FileObject.html#delete%28%29) in interface [FileObject](../../javax/tools/FileObject.html "interface in javax.tools")

Returns:

false

getKind

public JavaFileObject.Kind getKind()

Description copied from interface: [JavaFileObject](../../javax/tools/JavaFileObject.html#getKind%28%29)

Gets the kind of this file object.

Specified by:

[getKind](../../javax/tools/JavaFileObject.html#getKind%28%29) in interface [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")

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 tosimpleName + 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](../../javax/tools/JavaFileObject.html#isNameCompatible%28java.lang.String, javax.tools.JavaFileObject.Kind%29) in interface [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")

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 ofJavaFileObject is obeyed.

Specified by:

[getNestingKind](../../javax/tools/JavaFileObject.html#getNestingKind%28%29) in interface [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")

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 ofJavaFileObject is obeyed.

Specified by:

[getAccessLevel](../../javax/tools/JavaFileObject.html#getAccessLevel%28%29) in interface [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")

Returns:

the access level

toString

public String toString()

Description copied from class: [Object](../../java/lang/Object.html#toString%28%29)

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](../../java/lang/Object.html#toString%28%29) in class [Object](../../java/lang/Object.html "class in java.lang")

Returns:

a string representation of the object.

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, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.