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 SummaryNested classes/interfaces declared in interface javax.tools.JavaFileObjectJavaFileObject.Kind
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected final JavaFileObject.KindThe kind of this file object.protected final URIA URI for this file object.
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedSimpleJavaFileObject(URI uri, JavaFileObject.Kind kind) Construct a SimpleJavaFileObject of the given kind and with the given URI.
- 
Method SummaryModifier and TypeMethodDescriptionbooleandelete()This implementation does nothing.This implementation returnsnull.getCharContent(boolean ignoreEncodingErrors) This implementation always throws UnsupportedOperationException.getKind()Returns the kind of this file object.longThis implementation returns0L.getName()Returns a user-friendly name for this file object.This implementation returnsnull.booleanisNameCompatible(String simpleName, JavaFileObject.Kind kind) This implementation compares the path of its URI to the given simple name.This implementation always throws UnsupportedOperationException.This implementation always throws UnsupportedOperationException.openReader(boolean ignoreEncodingErrors) Wraps the result of getCharContent(boolean) in a Reader.Wraps the result of openOutputStream in a Writer.toUri()Returns a URI identifying this file object.
- 
Field Details- 
uriA URI for this file object.
- 
kindThe kind of this file object.
 
- 
- 
Constructor Details- 
SimpleJavaFileObjectConstruct 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 Details- 
toUriDescription copied from interface:FileObjectReturns a URI identifying this file object.- Specified by:
- toUriin interface- FileObject
- Returns:
- a URI
 
- 
getNameDescription copied from interface:FileObjectReturns 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:
- getNamein interface- FileObject
- Returns:
- a user-friendly name
 
- 
openInputStreamThis implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
- openInputStreamin interface- FileObject
- Returns:
- an InputStream
- Throws:
- IOException- if an I/O error occurred
 
- 
openOutputStreamThis implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
- openOutputStreamin interface- FileObject
- Returns:
- an OutputStream
- Throws:
- IOException- if an I/O error occurred
 
- 
openReaderWraps the result of getCharContent(boolean) in a Reader. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
- openReaderin interface- FileObject
- 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 reading
- UnsupportedOperationException- if this kind of file object does not support character access
- IOException- if an I/O error occurred
 
- 
getCharContentThis implementation always throws UnsupportedOperationException. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
- getCharContentin interface- FileObject
- Parameters:
- ignoreEncodingErrors- ignore encoding errors if true
- Returns:
- a CharSequence if available; nullotherwise
- Throws:
- IOException- if an I/O error occurred
 
- 
openWriterWraps the result of openOutputStream in a Writer. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
- openWriterin interface- FileObject
- Returns:
- a Writer wrapping the result of openOutputStream
- Throws:
- 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
- IOException- if an I/O error occurred
 
- 
getLastModifiedpublic long getLastModified()This implementation returns0L. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
- getLastModifiedin interface- FileObject
- Returns:
- 0L
 
- 
deletepublic boolean delete()This implementation does nothing. Subclasses can change this behavior as long as the contract ofFileObjectis obeyed.- Specified by:
- deletein interface- FileObject
- Returns:
- false
 
- 
getKindDescription copied from interface:JavaFileObjectReturns the kind of this file object.- Specified by:
- getKindin interface- JavaFileObject
- Returns:
- this.kind
 
- 
isNameCompatibleThis 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()andtoUri()and does not access the fieldsuriandkinddirectly.Subclasses can change this behavior as long as the contract of JavaFileObjectis obeyed.- Specified by:
- isNameCompatiblein interface- JavaFileObject
- Parameters:
- simpleName- a simple name of a class
- kind- a kind
- Returns:
- trueif this file object is compatible;- falseotherwise
 
- 
getNestingKindThis implementation returnsnull. Subclasses can change this behavior as long as the contract ofJavaFileObjectis obeyed.- Specified by:
- getNestingKindin interface- JavaFileObject
- Returns:
- the nesting kind, or nullif the nesting kind is not known
 
- 
getAccessLevelThis implementation returnsnull. Subclasses can change this behavior as long as the contract ofJavaFileObjectis obeyed.- Specified by:
- getAccessLevelin interface- JavaFileObject
- Returns:
- the access level
 
 
-