public Class SimpleJavaFileObject

Implements javax.tools.FileObject.delete.

Doc from javax.tools.FileObject.delete.

Deletes this file object. In case of errors, returns false.

Returns:boolean

false

Annotations

@Override

Creates a JavaFileObject which represents the given source content.

The provided uri will be returned from toUri(). The provided content will be returned from getCharContent(boolean). The getKind() method will return Kind#SOURCE.

All other methods will behave as described in the documentation in this class, as if the constructor is called with uri and Kind.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:URI

that should be used for the resulting JavaFileObject

content:String

the content of the JavaFileObject

Returns:JavaFileObject

a JavaFileObject representing the given source content.

Since

23

Implements javax.tools.JavaFileObject.getAccessLevel.

Doc from javax.tools.JavaFileObject.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 returns null.

Annotations

@Override

Implements javax.tools.FileObject.getCharContent.

Doc from javax.tools.FileObject.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 unless ignoreEncodingErrors is true.

Annotations

@Override

Exceptions

IOException:

if an I/O error occurred

Implements javax.tools.JavaFileObject.getKind.

Doc from javax.tools.JavaFileObject.getKind.

Returns the kind of this file object.

Returns:JavaFileObject.Kind

this.kind

Annotations

@Override

Implements javax.tools.FileObject.getLastModified.

Doc from javax.tools.FileObject.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).

Returns:long

0L

Annotations

@Override

Implements javax.tools.FileObject.getName.

Doc from javax.tools.FileObject.getName.

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 return file:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java.

Annotations

@Override

Implements javax.tools.JavaFileObject.getNestingKind.

Doc from javax.tools.JavaFileObject.getNestingKind.

Provides a hint about the nesting level of the class represented by this file object. This method may return NestingKind#MEMBER to mean NestingKind#LOCAL or NestingKind#ANONYMOUS. If the nesting level is not known or this file object does not represent a class file this method returns null.

Annotations

@Override

Implements javax.tools.JavaFileObject.isNameCompatible.

Doc from javax.tools.JavaFileObject.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.

Annotations

@Override

Implements javax.tools.FileObject.openInputStream.

Doc from javax.tools.FileObject.openInputStream.

Returns an InputStream for this file object.

Annotations

@Override

Exceptions

IOException:

if an I/O error occurred

Implements javax.tools.FileObject.openOutputStream.

Doc from javax.tools.FileObject.openOutputStream.

Returns an OutputStream for this file object.

Annotations

@Override

Exceptions

IOException:

if an I/O error occurred

Implements javax.tools.FileObject.openReader.

Doc from javax.tools.FileObject.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 unless ignoreEncodingErrors is true.

Returns:Reader

a Reader wrapping the result of getCharContent

Annotations

@Override

Exceptions

IOException:

if an I/O error occurred

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

Implements javax.tools.FileObject.openWriter.

Doc from javax.tools.FileObject.openWriter.

Returns a Writer for this file object.

Returns:Writer

a Writer wrapping the result of openOutputStream

Annotations

@Override

Exceptions

IOException:

if an I/O error occurred

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

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

Implements javax.tools.FileObject.toUri.

Doc from javax.tools.FileObject.toUri.

Returns a URI identifying this file object.

Annotations

@Override