- 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
-
-
Nested Class Summary
-
Nested classes/interfaces declared in interface javax.tools.JavaFileObject
JavaFileObject.Kind
-
-
Field Summary
Fields Modifier and Type Field Description protected JavaFileObject.KindkindThe kind of this file object.protected URIuriA URI for this file object.
-
Constructor Summary
Constructors Modifier Constructor Description protectedSimpleJavaFileObject(URI uri, JavaFileObject.Kind kind)Construct a SimpleJavaFileObject of the given kind and with the given URI.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleandelete()This implementation does nothing.ModifiergetAccessLevel()This implementation returnsnull.CharSequencegetCharContent(boolean ignoreEncodingErrors)This implementation always throws UnsupportedOperationException.JavaFileObject.KindgetKind()Returns the kind of this file object.longgetLastModified()This implementation returns0L.NestingKindgetNestingKind()This implementation returnsnull.booleanisNameCompatible(String simpleName, JavaFileObject.Kind kind)This implementation compares the path of its URI to the given simple name.InputStreamopenInputStream()This implementation always throws UnsupportedOperationException.OutputStreamopenOutputStream()This implementation always throws UnsupportedOperationException.ReaderopenReader(boolean ignoreEncodingErrors)Wraps the result of getCharContent(boolean) in a Reader.WriteropenWriter()Wraps the result of openOutputStream in a Writer.-
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods declared in interface javax.tools.FileObject
getName, toUri
-
-
-
-
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 objectkind- the kind of this file object
-
-
Method Detail
-
openInputStream
public InputStream openInputStream() throws IOException
This implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
openInputStreamin interfaceFileObject- 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 ofFileObjectis obeyed.- Specified by:
openOutputStreamin interfaceFileObject- 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 ofFileObjectis obeyed.- Specified by:
openReaderin interfaceFileObject- 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 readingUnsupportedOperationException- if this kind of file object does not support character accessIOException- 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 ofFileObjectis obeyed.- Specified by:
getCharContentin interfaceFileObject- Parameters:
ignoreEncodingErrors- ignore encoding errors if true- Returns:
- a CharSequence if available;
nullotherwise - 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 ofFileObjectis obeyed.- Specified by:
openWriterin interfaceFileObject- Returns:
- a Writer wrapping the result of openOutputStream
- Throws:
IllegalStateException- if this file object was opened for reading and does not support writingUnsupportedOperationException- if this kind of file object does not support character accessIOException- if an I/O error occurred
-
getLastModified
public long getLastModified()
This implementation returns0L. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
getLastModifiedin interfaceFileObject- Returns:
0L
-
delete
public boolean delete()
This implementation does nothing. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
deletein interfaceFileObject- Returns:
false
-
getKind
public JavaFileObject.Kind getKind()
Description copied from interface:JavaFileObjectReturns the kind of this file object.- Specified by:
getKindin interfaceJavaFileObject- 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.extensionor if it ends with"/" + simpleName + kind.extension.This method calls
getKind()andFileObject.toUri()and does not access the fieldsuriandkinddirectly.Subclasses can change this behavior as long as the contract of
JavaFileObjectis obeyed.- Specified by:
isNameCompatiblein interfaceJavaFileObject- Parameters:
simpleName- a simple name of a classkind- a kind- Returns:
trueif this file object is compatible; false otherwise
-
getNestingKind
public NestingKind getNestingKind()
This implementation returnsnull. Subclasses can change this behavior as long as the contract ofJavaFileObjectis obeyed.- Specified by:
getNestingKindin interfaceJavaFileObject- Returns:
- the nesting kind, or
nullif the nesting kind is not known
-
getAccessLevel
public Modifier getAccessLevel()
This implementation returnsnull. Subclasses can change this behavior as long as the contract ofJavaFileObjectis obeyed.- Specified by:
getAccessLevelin interfaceJavaFileObject- Returns:
- the access level
-
-