Class SimpleJavaFileObject
java.lang.Object
javax.tools.SimpleJavaFileObject
- All Implemented Interfaces:
FileObject
,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
Modifier and TypeFieldDescriptionprotected final JavaFileObject.Kind
The kind of this file object.protected final URI
A URI for this file object. -
Constructor Summary
ModifierConstructorDescriptionprotected
SimpleJavaFileObject
(URI uri, JavaFileObject.Kind kind) Construct a SimpleJavaFileObject of the given kind and with the given URI. -
Method Summary
Modifier and TypeMethodDescriptionboolean
delete()
Deletes this file object.static JavaFileObject
Creates aJavaFileObject
which represents the given source content.Provides a hint about the access level of the class represented by this file object.getCharContent
(boolean ignoreEncodingErrors) Returns the character content of this file object, if available.getKind()
Returns the kind of this file object.long
Returns the time this file object was last modified.getName()
Returns a user-friendly name for this file object.Provides a hint about the nesting level of the class represented by this file object.boolean
isNameCompatible
(String simpleName, JavaFileObject.Kind kind) Checks if this file object is compatible with the specified simple name and kind.Returns an InputStream for this file object.Returns an OutputStream for this file object.openReader
(boolean ignoreEncodingErrors) Returns a reader for this object.Returns a Writer for this file object.toUri()
Returns a URI identifying this file object.
-
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
-
toUri
Description copied from interface:FileObject
Returns a URI identifying this file object.- Specified by:
toUri
in interfaceFileObject
- Returns:
- a URI
-
getName
Description copied from interface:FileObject
Returns 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 returnfile:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java
.- Specified by:
getName
in interfaceFileObject
- Returns:
- a user-friendly name
-
openInputStream
Returns an InputStream for this file object.- Specified by:
openInputStream
in interfaceFileObject
- Implementation Requirements:
- This implementation always throws UnsupportedOperationException.
- Returns:
- an InputStream
- Throws:
IOException
- if an I/O error occurred
-
openOutputStream
Returns an OutputStream for this file object.- Specified by:
openOutputStream
in interfaceFileObject
- Implementation Requirements:
- This implementation always throws UnsupportedOperationException.
- Returns:
- an OutputStream
- Throws:
IOException
- if an I/O error occurred
-
openReader
Returns 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 unlessignoreEncodingErrors
is true.- Specified by:
openReader
in interfaceFileObject
- Implementation Requirements:
- This implementation wraps the result of
getCharContent(boolean)
in aReader
. - 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
Returns 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 unlessignoreEncodingErrors
is true.- Specified by:
getCharContent
in interfaceFileObject
- Implementation Requirements:
- This implementation always throws UnsupportedOperationException.
- Parameters:
ignoreEncodingErrors
- ignore encoding errors if true- Returns:
- a CharSequence if available;
null
otherwise - Throws:
IOException
- if an I/O error occurred
-
openWriter
Returns a Writer for this file object.- Specified by:
openWriter
in interfaceFileObject
- Implementation Requirements:
- This implementation wraps the result of
openOutputStream()
in aWriter
. - 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()Returns 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 interfaceFileObject
- Implementation Requirements:
- This implementation returns
0L
. - Returns:
0L
-
delete
public boolean delete()Deletes this file object. In case of errors, returns false.- Specified by:
delete
in interfaceFileObject
- Implementation Requirements:
- This implementation does nothing.
- Returns:
false
-
getKind
Description copied from interface:JavaFileObject
Returns the kind of this file object.- Specified by:
getKind
in interfaceJavaFileObject
- Returns:
this.kind
-
isNameCompatible
Checks if this file object is compatible with the specified simple name and kind. A simple name is a single identifier (not qualified) as defined in The Java Language Specification, section 6.2.- Specified by:
isNameCompatible
in interfaceJavaFileObject
- Implementation Requirements:
- 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()
andtoUri()
and does not access the fieldsuri
andkind
directly. - Parameters:
simpleName
- a simple name of a classkind
- a kind- Returns:
true
if this file object is compatible;false
otherwise
-
getNestingKind
Provides a hint about the nesting level of the class represented by this file object. This method may returnNestingKind.MEMBER
to meanNestingKind.LOCAL
orNestingKind.ANONYMOUS
. If the nesting level is not known or this file object does not represent a class file this method returnsnull
.- Specified by:
getNestingKind
in interfaceJavaFileObject
- Implementation Requirements:
- This implementation returns
null
. - Returns:
- the nesting kind, or
null
if the nesting kind is not known
-
getAccessLevel
Provides a hint about the access level of the class represented by this file object. If the access level is not known or this file object does not represent a class file this method returnsnull
.- Specified by:
getAccessLevel
in interfaceJavaFileObject
- Implementation Requirements:
- This implementation returns
null
. - Returns:
- the access level
-
forSource
Creates aJavaFileObject
which represents the given source content.The provided
uri
will be returned fromtoUri()
. The providedcontent
will be returned fromgetCharContent(boolean)
. ThegetKind()
method will returnJavaFileObject.Kind.SOURCE
.All other methods will behave as described in the documentation in this class, as if the constructor is called with
uri
andKind.SOURCE
.This method can be, for example, used to compile an in-memory String to a set of classfile in a target directory:
var code = """ public class CompiledCode {} """; var compiler = ToolProvider.getSystemJavaCompiler(); var targetDirectory = "..."; var task = compiler.getTask(null, null, null, List.of("-d", targetDirectory), null, List.of(SimpleJavaFileObject.forSource(URI.create("CompiledCode.java"), code))); if (!task.call()) { throw new IllegalStateException("Compilation failed!"); }
- Parameters:
uri
- that should be used for the resultingJavaFileObject
content
- the content of theJavaFileObject
- Returns:
- a
JavaFileObject
representing the given source content. - Since:
- 23
-