StandardLocation (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.lang.Enum<StandardLocation>
  • • javax.tools.StandardLocation

• All Implemented Interfaces:
  Serializable, Comparable<StandardLocation>, JavaFileManager.Location

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_PATH	Location to search for annotation processors.
  CLASS_OUTPUT	Location of new class files.
  CLASS_PATH	Location to search for user class files.
  NATIVE_HEADER_OUTPUT	Location of new native header files.
  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.

  • Method Summary

  All Methods Static Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  String	getName()	Gets the name of this location.
  boolean	isOutputLocation()	Determines if this is an output location.
  static JavaFileManager.Location	locationFor(String name)	Gets 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 inherited from class java.lang.[Enum](../../java/lang/Enum.html "class in java.lang")  
     `[clone](../../java/lang/Enum.html#clone--), [compareTo](../../java/lang/Enum.html#compareTo-E-), [equals](../../java/lang/Enum.html#equals-java.lang.Object-), [finalize](../../java/lang/Enum.html#finalize--), [getDeclaringClass](../../java/lang/Enum.html#getDeclaringClass--), [hashCode](../../java/lang/Enum.html#hashCode--), [name](../../java/lang/Enum.html#name--), [ordinal](../../java/lang/Enum.html#ordinal--), [toString](../../java/lang/Enum.html#toString--), [valueOf](../../java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Enum Constant Detail

     * #### CLASS\_OUTPUT  
     public static final [StandardLocation](../../javax/tools/StandardLocation.html "enum in javax.tools") CLASS_OUTPUT  
     Location of new class files.  
     * #### SOURCE\_OUTPUT  
     public static final [StandardLocation](../../javax/tools/StandardLocation.html "enum in javax.tools") SOURCE_OUTPUT  
     Location of new source files.  
     * #### CLASS\_PATH  
     public static final [StandardLocation](../../javax/tools/StandardLocation.html "enum in javax.tools") CLASS_PATH  
     Location to search for user class files.  
     * #### SOURCE\_PATH  
     public static final [StandardLocation](../../javax/tools/StandardLocation.html "enum in javax.tools") SOURCE_PATH  
     Location to search for existing source files.  
     * #### ANNOTATION\_PROCESSOR\_PATH  
     public static final [StandardLocation](../../javax/tools/StandardLocation.html "enum in javax.tools") ANNOTATION_PROCESSOR_PATH  
     Location to search for annotation processors.  
     * #### PLATFORM\_CLASS\_PATH  
     public static final [StandardLocation](../../javax/tools/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](../../javax/tools/StandardLocation.html "enum in javax.tools") NATIVE_HEADER_OUTPUT  
     Location of new native header files.  
     Since:  
     1.8  

  • Method Detail

    * #### values  
    public static [StandardLocation](../../javax/tools/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](../../javax/tools/StandardLocation.html "enum in javax.tools") valueOf([String](../../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/lang/IllegalArgumentException.html "class in java.lang")` \- if this enum type has no constant with the specified name  
    `[NullPointerException](../../java/lang/NullPointerException.html "class in java.lang")` \- if the argument is null  
    * #### locationFor  
    public static [JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools") locationFor([String](../../java/lang/String.html "class in java.lang") name)  
    Gets 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"`.  
    Parameters:  
    `name` \- a name  
    Returns:  
    a location  
    * #### getName  
    public [String](../../java/lang/String.html "class in java.lang") getName()  
    Gets the name of this location.  
    Specified by:  
    `[getName](../../javax/tools/JavaFileManager.Location.html#getName--)` in interface `[JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools")`  
    Returns:  
    a name  
    * #### isOutputLocation  
    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](../../javax/tools/JavaFileManager.Location.html#isOutputLocation--)` in interface `[JavaFileManager.Location](../../javax/tools/JavaFileManager.Location.html "interface in javax.tools")`  
    Returns:  
    true if this is an output location, false otherwise

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.