StandardLocation (Java SE 15 & JDK 15) (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 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")

public enum StandardLocation extends Enum<StandardLocation> implements JavaFileManager.Location

Standard locations of file objects.

Since:

1.6

• Nested Class Summary

• Enum Constant Summary

Enum Constants

• Method Summary

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:
  9

  • PLATFORM_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:
  9

  • UPGRADE_MODULE_PATH

  Location to search for upgradeable system modules.
  Since:
  9

  • SYSTEM_MODULES

  Location to search for system modules.
  Since:
  9

  • MODULE_PATH

  Location to search for precompiled user modules.
  Since:
  9

  • PATCH_MODULE_PATH

  Location to search for module patches.
  Since:
  9

• Method Details

  • values

  Returns an array containing the constants of this enum type, in the order they are declared.
  Returns:
  an array containing the constants of this enum type, in the order they are declared

  • valueOf

  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

  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