Interface JavaFileObject
- All Superinterfaces:
FileObject
- All Known Implementing Classes:
-
ForwardingJavaFileObject,SimpleJavaFileObject
public interface JavaFileObject extends FileObject
File abstraction for tools operating on Java programming language source and class files.
All methods in this interface might throw a SecurityException if a security exception occurs.
Unless explicitly allowed, all methods in this interface might throw a NullPointerException if given a null argument.
- Since:
- 1.6
- See Also:
Nested Class Summary
| Modifier and Type | Interface | Description |
|---|---|---|
static enum |
JavaFileObject.Kind |
Kinds of JavaFileObjects. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
Modifier |
getAccessLevel() |
Provides a hint about the access level of the class represented by this file object. |
JavaFileObject.Kind |
getKind() |
Returns the kind of this file object. |
NestingKind |
getNestingKind() |
Provides a hint about the nesting level of the class represented by this file object. |
boolean |
isNameCompatible |
Checks if this file object is compatible with the specified simple name and kind. |
Methods declared in interface javax.tools.FileObject
delete, getCharContent, getLastModified, getName, openInputStream, openOutputStream, openReader, openWriter, toUri
Method Details
getKind
JavaFileObject.Kind getKind()
Returns the kind of this file object.
- Returns:
- the kind
isNameCompatible
boolean isNameCompatible(String simpleName, JavaFileObject.Kind kind)
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.
- Parameters:
-
simpleName- a simple name of a class -
kind- a kind - Returns:
-
trueif this file object is compatible;falseotherwise
getNestingKind
NestingKind 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.- Returns:
- the nesting kind, or
nullif the nesting kind is not known
getAccessLevel
Modifier 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.- Returns:
- the access level
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/tools/JavaFileObject.html