SimpleJavaFileObject (Java SE 10 & JDK 10 ) (original) (raw)

java.lang.Object
- javax.tools.SimpleJavaFileObject
All Implemented Interfaces:
[FileObject](../../javax/tools/FileObject.html "interface in javax.tools"), [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools")

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](../../javax/tools/JavaFileObject.html "interface in javax.tools")  
 `[JavaFileObject.Kind](../../javax/tools/JavaFileObject.Kind.html "enum in javax.tools")`

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

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
boolean	delete()	This implementation does nothing.
Modifier	getAccessLevel()	This implementation returns null.
CharSequence	getCharContent(boolean ignoreEncodingErrors)	This implementation always throws UnsupportedOperationException.
JavaFileObject.Kind	getKind()	Returns the kind of this file object.
long	getLastModified()	This implementation returns 0L.
NestingKind	getNestingKind()	This implementation returns null.
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 interface javax.tools.[FileObject](../../javax/tools/FileObject.html "interface in javax.tools")  
   `[getName](../../javax/tools/FileObject.html#getName%28%29), [toUri](../../javax/tools/FileObject.html#toUri%28%29)`  
   * ### Methods declared in class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
   `[clone](../../java/lang/Object.html#clone%28%29), [equals](../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [toString](../../java/lang/Object.html#toString%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,int%29)`

Field Detail

 * #### uri  
 protected final [URI](../../java/net/URI.html "class in java.net") uri  
 A URI for this file object.  
 * #### kind  
 protected final [JavaFileObject.Kind](../../javax/tools/JavaFileObject.Kind.html "enum in javax.tools") kind  
 The kind of this file object.

Constructor Detail

* #### SimpleJavaFileObject  
protected SimpleJavaFileObject([URI](../../java/net/URI.html "class in java.net") uri,  
                               [JavaFileObject.Kind](../../javax/tools/JavaFileObject.Kind.html "enum in javax.tools") 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

Method Detail

* #### openInputStream  
public [InputStream](../../java/io/InputStream.html "class in java.io") openInputStream()  
                            throws [IOException](../../java/io/IOException.html "class in java.io")  
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](../../java/io/OutputStream.html "class in java.io") openOutputStream()  
                              throws [IOException](../../java/io/IOException.html "class in java.io")  
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](../../java/io/Reader.html "class in java.io") openReader(boolean ignoreEncodingErrors)  
                  throws [IOException](../../java/io/IOException.html "class in java.io")  
Wraps the result of [getCharContent(boolean)](../../javax/tools/SimpleJavaFileObject.html#getCharContent%28boolean%29) in a Reader. Subclasses can change this behavior as long as the contract of[FileObject](../../javax/tools/FileObject.html "interface in javax.tools") 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](../../java/lang/CharSequence.html "interface in java.lang") getCharContent(boolean ignoreEncodingErrors)  
                            throws [IOException](../../java/io/IOException.html "class in java.io")  
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](../../java/io/Writer.html "class in java.io") openWriter()  
                  throws [IOException](../../java/io/IOException.html "class in java.io")  
Wraps the result of openOutputStream in a Writer. Subclasses can change this behavior as long as the contract of [FileObject](../../javax/tools/FileObject.html "interface in javax.tools") 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](../../javax/tools/FileObject.html "interface in javax.tools") 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](../../javax/tools/FileObject.html "interface in javax.tools") 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](../../javax/tools/JavaFileObject.Kind.html "enum in javax.tools") getKind()  
Returns 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](../../java/lang/String.html "class in java.lang") simpleName,  
                                [JavaFileObject.Kind](../../javax/tools/JavaFileObject.Kind.html "enum in javax.tools") 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 to`simpleName + kind.extension` or if it ends with ` "/" + simpleName + kind.extension`.  
This method calls [getKind()](../../javax/tools/SimpleJavaFileObject.html#getKind%28%29) and [FileObject.toUri()](../../javax/tools/FileObject.html#toUri%28%29) and does not access the fields [uri](../../javax/tools/SimpleJavaFileObject.html#uri) and [kind](../../javax/tools/SimpleJavaFileObject.html#kind) directly.  
Subclasses can change this behavior as long as the contract of [JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools") 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](../../javax/lang/model/element/NestingKind.html "enum in javax.lang.model.element") getNestingKind()  
This implementation returns `null`. Subclasses can change this behavior as long as the contract of[JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools") 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](../../javax/lang/model/element/Modifier.html "enum in javax.lang.model.element") getAccessLevel()  
This implementation returns `null`. Subclasses can change this behavior as long as the contract of[JavaFileObject](../../javax/tools/JavaFileObject.html "interface in javax.tools") 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

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2018, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

SimpleJavaFileObject (Java SE 10 & JDK 10 ) (original) (raw)

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail