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.Kind
kind
The kind of this file object.protected URI
uri
A URI for this file object. -
Constructor Summary
Constructors Modifier Constructor Description protected
SimpleJavaFileObject(URI uri, JavaFileObject.Kind kind)
Construct a SimpleJavaFileObject of the given kind and with the given URI. -
Method Summary
Modifier and Type Method Description boolean
delete()
This implementation does nothing.Modifier
getAccessLevel()
This implementation returnsnull
.CharSequence
getCharContent(boolean ignoreEncodingErrors)
This implementation always throws UnsupportedOperationException.JavaFileObject.Kind
getKind()
Returns the kind of this file object.long
getLastModified()
This implementation returns0L
.NestingKind
getNestingKind()
This implementation returnsnull
.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.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 Details
-
uri
A URI for this file object. -
kind
The kind of this file object.
-
-
Constructor Details
-
SimpleJavaFileObject
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 Details
-
openInputStream
This implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract ofFileObject
is obeyed.- Specified by:
openInputStream
in interfaceFileObject
- Returns:
- an InputStream
- Throws:
IOException
- if an I/O error occurred
-
openOutputStream
This implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract ofFileObject
is obeyed.- Specified by:
openOutputStream
in interfaceFileObject
- Returns:
- an OutputStream
- Throws:
IOException
- if an I/O error occurred
-
openReader
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
in 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
This implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract ofFileObject
is obeyed.- Specified by:
getCharContent
in interfaceFileObject
- Parameters:
ignoreEncodingErrors
- ignore encoding errors if true- Returns:
- a CharSequence if available;
null
otherwise - Throws:
IOException
- if an I/O error occurred
-
openWriter
Wraps the result of openOutputStream in a Writer. Subclasses can change this behavior as long as the contract ofFileObject
is obeyed.- Specified by:
openWriter
in 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 ofFileObject
is obeyed.- Specified by:
getLastModified
in interfaceFileObject
- Returns:
0L
-
delete
public boolean delete()This implementation does nothing. Subclasses can change this behavior as long as the contract ofFileObject
is obeyed.- Specified by:
delete
in interfaceFileObject
- Returns:
false
-
getKind
Description copied from interface:JavaFileObject
Returns the kind of this file object.- Specified by:
getKind
in interfaceJavaFileObject
- Returns:
this.kind
-
isNameCompatible
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()
andFileObject.toUri()
and does not access the fieldsuri
andkind
directly.Subclasses can change this behavior as long as the contract of
JavaFileObject
is obeyed.- Specified by:
isNameCompatible
in interfaceJavaFileObject
- Parameters:
simpleName
- a simple name of a classkind
- a kind- Returns:
true
if this file object is compatible; false otherwise
-
getNestingKind
This implementation returnsnull
. Subclasses can change this behavior as long as the contract ofJavaFileObject
is obeyed.- Specified by:
getNestingKind
in interfaceJavaFileObject
- Returns:
- the nesting kind, or
null
if the nesting kind is not known
-
getAccessLevel
This implementation returnsnull
. Subclasses can change this behavior as long as the contract ofJavaFileObject
is obeyed.- Specified by:
getAccessLevel
in interfaceJavaFileObject
- Returns:
- the access level
-