StandardLocation (Java SE 16 & JDK 16) (original) (raw)
All Implemented Interfaces:
[Serializable](../../../java.base/java/io/Serializable.html "interface in java.io"), [Comparable](../../../java.base/java/lang/Comparable.html "interface in java.lang")<[StandardLocation](StandardLocation.html "enum class in javax.tools")>, [Constable](../../../java.base/java/lang/constant/Constable.html "interface in java.lang.constant"), [JavaFileManager.Location](JavaFileManager.Location.html "interface in javax.tools")
Standard locations of file objects.
Since:
1.6
Nested Class Summary
Enum Constant Summary
Enum Constants
Location to search for modules containing annotation processors.
Location to search for annotation processors.
Location of new class files.
Location to search for user class files.
Location to search for precompiled user modules.
Location to search for the source code of modules.
Location of new native header files.
Location to search for module patches.
Location to search for platform classes.
Location of new source files.
Location to search for existing source files.
Location to search for system modules.
Location to search for upgradeable system modules.
Method Summary
[getName](#getName%28%29)()
Returns the name of this location.boolean
Indicates if this location is module-oriented location, and therefore expected to contain classes in a module/package/class hierarchy, as compared to a package-oriented location, which is expected to contain classes in a package/class hierarchy.boolean
Determines if this is an output location.
Returns a location object with the given name.
Returns the enum constant of this class with the specified name.[values](#values%28%29)()
Returns an array containing the constants of this enum class, in the order they are declared.
Methods declared in class java.lang.Enum
[clone](../../../java.base/java/lang/Enum.html#clone%28%29), [compareTo](../../../java.base/java/lang/Enum.html#compareTo%28E%29), [describeConstable](../../../java.base/java/lang/Enum.html#describeConstable%28%29), [equals](../../../java.base/java/lang/Enum.html#equals%28java.lang.Object%29), [finalize](../../../java.base/java/lang/Enum.html#finalize%28%29), [getDeclaringClass](../../../java.base/java/lang/Enum.html#getDeclaringClass%28%29), [hashCode](../../../java.base/java/lang/Enum.html#hashCode%28%29), [name](../../../java.base/java/lang/Enum.html#name%28%29), [ordinal](../../../java.base/java/lang/Enum.html#ordinal%28%29), [toString](../../../java.base/java/lang/Enum.html#toString%28%29), [valueOf](../../../java.base/java/lang/Enum.html#valueOf%28java.lang.Class,java.lang.String%29)
Enum Constant Details
CLASS_OUTPUT
Location of new class files.
SOURCE_OUTPUT
Location of new source files.
CLASS_PATH
Location to search for user class files.
SOURCE_PATH
Location to search for existing source files.
ANNOTATION_PROCESSOR_PATH
Location to search for annotation processors.
ANNOTATION_PROCESSOR_MODULE_PATH
public static final StandardLocation ANNOTATION_PROCESSOR_MODULE_PATH
Location to search for modules containing annotation processors.
Since:
9PLATFORM_CLASS_PATH
Location to search for platform classes. Sometimes called the boot class path.
MODULE_SOURCE_PATH
Location to search for the source code of modules.
Since:
9UPGRADE_MODULE_PATH
Location to search for upgradeable system modules.
Since:
9SYSTEM_MODULES
Location to search for system modules.
Since:
9MODULE_PATH
Location to search for precompiled user modules.
Since:
9PATCH_MODULE_PATH
Location to search for module patches.
Since:
9Method Details
values
Returns an array containing the constants of this enum class, in the order they are declared.
Returns:
an array containing the constants of this enum class, in the order they are declaredvalueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
Parameters:
name- the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
[IllegalArgumentException](../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")- if this enum class has no constant with the specified name
[NullPointerException](../../../java.base/java/lang/NullPointerException.html "class in java.lang")- if the argument is nulllocationFor
Returns a location object with the given name. The following property must hold:
locationFor(x) == locationFor(y)if and only ifx.equals(y). The returned location will be an output location if and only if name ends with"_OUTPUT". It will be considered to be a module-oriented location if the name contains the word"MODULE".
Parameters:
name- a name
Returns:
a locationgetName
Returns the name of this location.
Specified by:
[getName](JavaFileManager.Location.html#getName%28%29)in interface[JavaFileManager.Location](JavaFileManager.Location.html "interface in javax.tools")
Returns:
a nameisOutputLocation
public boolean isOutputLocation()
Determines if this is an output location. An output location is a location that is conventionally used for output.
Specified by:
[isOutputLocation](JavaFileManager.Location.html#isOutputLocation%28%29)in interface[JavaFileManager.Location](JavaFileManager.Location.html "interface in javax.tools")
Returns:
true if this is an output location, false otherwiseisModuleOrientedLocation
public boolean isModuleOrientedLocation()
Indicates if this location is module-oriented location, and therefore expected to contain classes in a module/package/class hierarchy, as compared to a package-oriented location, which is expected to contain classes in a package/class hierarchy. The result of this method is undefined if this is an output location.
Specified by:
[isModuleOrientedLocation](JavaFileManager.Location.html#isModuleOrientedLocation%28%29)in interface[JavaFileManager.Location](JavaFileManager.Location.html "interface in javax.tools")
Returns:
true if this location is expected to contain modules
Since:
9