StandardLocation (Java SE 11 & JDK 11 ) (original) (raw)

java.lang.Object
- java.lang.Enum<StandardLocation>
- - javax.tools.StandardLocation
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 in javax.tools")>, [JavaFileManager.Location](JavaFileManager.Location.html "interface in javax.tools")

public enum StandardLocation
extends Enum<StandardLocation>
implements JavaFileManager.Location
Standard locations of file objects.
Since:
1.6

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANNOTATION_PROCESSOR_MODULE_PATH	Location to search for modules containing annotation processors.
ANNOTATION_PROCESSOR_PATH	Location to search for annotation processors.
CLASS_OUTPUT	Location of new class files.
CLASS_PATH	Location to search for user class files.
MODULE_PATH	Location to search for precompiled user modules.
MODULE_SOURCE_PATH	Location to search for the source code of modules.
NATIVE_HEADER_OUTPUT	Location of new native header files.
PATCH_MODULE_PATH	Location to search for module patches.
PLATFORM_CLASS_PATH	Location to search for platform classes.
SOURCE_OUTPUT	Location of new source files.
SOURCE_PATH	Location to search for existing source files.
SYSTEM_MODULES	Location to search for system modules.
UPGRADE_MODULE_PATH	Location to search for upgradeable system modules.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
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.
static JavaFileManager.Location	locationFor(String name)	Returns a location object with the given name.
static StandardLocation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StandardLocation[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

   * ### Methods declared in class java.lang.[Enum](../../../java.base/java/lang/Enum.html "class in java.lang")  
   `[clone](../../../java.base/java/lang/Enum.html#clone%28%29), [compareTo](../../../java.base/java/lang/Enum.html#compareTo%28E%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)`  
   * ### Methods declared in class java.lang.[Object](../../../java.base/java/lang/Object.html "class in java.lang")  
   `[getClass](../../../java.base/java/lang/Object.html#getClass%28%29), [notify](../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../java.base/java/lang/Object.html#notifyAll%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../java.base/java/lang/Object.html#wait%28long,int%29)`  
   * ### Methods declared in interface javax.tools.[JavaFileManager.Location](JavaFileManager.Location.html "interface in javax.tools")  
   `[getName](JavaFileManager.Location.html#getName%28%29), [isOutputLocation](JavaFileManager.Location.html#isOutputLocation%28%29)`

Enum Constant Detail

 * #### CLASS\_OUTPUT  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") CLASS_OUTPUT  
 Location of new class files.  
 * #### SOURCE\_OUTPUT  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") SOURCE_OUTPUT  
 Location of new source files.  
 * #### CLASS\_PATH  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") CLASS_PATH  
 Location to search for user class files.  
 * #### SOURCE\_PATH  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") SOURCE_PATH  
 Location to search for existing source files.  
 * #### ANNOTATION\_PROCESSOR\_PATH  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") ANNOTATION_PROCESSOR_PATH  
 Location to search for annotation processors.  
 * #### ANNOTATION\_PROCESSOR\_MODULE\_PATH  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") ANNOTATION_PROCESSOR_MODULE_PATH  
 Location to search for modules containing annotation processors.  
 Since:  
 9  
 * #### PLATFORM\_CLASS\_PATH  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") PLATFORM_CLASS_PATH  
 Location to search for platform classes. Sometimes called the boot class path.  
 * #### NATIVE\_HEADER\_OUTPUT  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") NATIVE_HEADER_OUTPUT  
 Location of new native header files.  
 Since:  
 1.8  
 * #### MODULE\_SOURCE\_PATH  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") MODULE_SOURCE_PATH  
 Location to search for the source code of modules.  
 Since:  
 9  
 * #### UPGRADE\_MODULE\_PATH  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") UPGRADE_MODULE_PATH  
 Location to search for upgradeable system modules.  
 Since:  
 9  
 * #### SYSTEM\_MODULES  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") SYSTEM_MODULES  
 Location to search for system modules.  
 Since:  
 9  
 * #### MODULE\_PATH  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") MODULE_PATH  
 Location to search for precompiled user modules.  
 Since:  
 9  
 * #### PATCH\_MODULE\_PATH  
 public static final [StandardLocation](StandardLocation.html "enum in javax.tools") PATCH_MODULE_PATH  
 Location to search for module patches.  
 Since:  
 9

Method Detail

* #### values  
public static [StandardLocation](StandardLocation.html "enum in javax.tools")[] values()  
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:  
for (StandardLocation c : StandardLocation.values())  
    System.out.println(c);  
Returns:  
an array containing the constants of this enum type, in the order they are declared  
* #### valueOf  
public static [StandardLocation](StandardLocation.html "enum in javax.tools") valueOf([String](../../../java.base/java/lang/String.html "class in java.lang") name)  
Returns the enum constant of this type with the specified name. The string must match _exactly_ an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name  
`[NullPointerException](../../../java.base/java/lang/NullPointerException.html "class in java.lang")` \- if the argument is null  
* #### locationFor  
public static [JavaFileManager.Location](JavaFileManager.Location.html "interface in javax.tools") locationFor([String](../../../java.base/java/lang/String.html "class in java.lang") name)  
Returns a location object with the given name. The following property must hold: `locationFor(x) == locationFor(y)` if and only if `x.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 location  
* #### isModuleOrientedLocation  
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

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, 2025, 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.

StandardLocation (Java SE 11 & JDK 11 ) (original) (raw)

Enum Constant Summary

Method Summary

Enum Constant Detail

Method Detail