APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javax.tools

public final Enum StandardLocation

extends Enum<StandardLocation>
implements Location
Class Inheritance
All Implemented Interfaces
javax.tools.JavaFileManager.Location
Imports
javax.tools.JavaFileManager.Location, java.util.Objects, java.util.concurrent.*, java.util.regex.Pattern

Standard locations of file objects.
Since
1.6

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
public static final StandardLocation
ANNOTATION_PROCESSOR_MODULE_PATH

Location to search for modules containing annotation processors.

public static final StandardLocation
ANNOTATION_PROCESSOR_PATH

Location to search for annotation processors.

public static final StandardLocation
CLASS_OUTPUT

Location of new class files.

public static final StandardLocation
CLASS_PATH

Location to search for user class files.

private static final ConcurrentHashMap<String, JavaFileManager.Location>
LOCATIONS

Canonical location instances.

public static final StandardLocation
MODULE_PATH

Location to search for precompiled user modules.

public static final StandardLocation
MODULE_SOURCE_PATH

Location to search for the source code of modules.

public static final StandardLocation
NATIVE_HEADER_OUTPUT

Location of new native header files.

public static final StandardLocation
PATCH_MODULE_PATH

Location to search for module patches.

public static final StandardLocation
PLATFORM_CLASS_PATH

Location to search for platform classes.

public static final StandardLocation
SOURCE_OUTPUT

Location of new source files.

public static final StandardLocation
SOURCE_PATH

Location to search for existing source files.

public static final StandardLocation
SYSTEM_MODULES

Location to search for system modules.

public static final StandardLocation
UPGRADE_MODULE_PATH

Location to search for upgradeable system modules.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
pack-priv static final boolean
public String
getName()

Implements javax.tools.JavaFileManager.Location.getName.

Returns the name of this location.

public boolean
isModuleOrientedLocation()

Overrides default javax.tools.JavaFileManager.Location.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.

public boolean
isOutputLocation()

Implements javax.tools.JavaFileManager.Location.isOutputLocation.

Determines if this is an output location.

public static JavaFileManager.Location

Returns:

a location
locationFor
(final String
a name
name
)

Returns a location object with the given name.

public static StandardLocation
public static StandardLocation[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ANNOTATION_PROCESSOR_MODULE_PATHback to summary
public static final StandardLocation ANNOTATION_PROCESSOR_MODULE_PATH

Location to search for modules containing annotation processors.

Since
9
ANNOTATION_PROCESSOR_PATHback to summary
public static final StandardLocation ANNOTATION_PROCESSOR_PATH

Location to search for annotation processors.

CLASS_OUTPUTback to summary
public static final StandardLocation CLASS_OUTPUT

Location of new class files.

CLASS_PATHback to summary
public static final StandardLocation CLASS_PATH

Location to search for user class files.

LOCATIONSback to summary
private static final ConcurrentHashMap<String, JavaFileManager.Location> LOCATIONS

Canonical location instances.

MODULE_PATHback to summary
public static final StandardLocation MODULE_PATH

Location to search for precompiled user modules.

Since
9
MODULE_SOURCE_PATHback to summary
public static final StandardLocation MODULE_SOURCE_PATH

Location to search for the source code of modules.

Since
9
NATIVE_HEADER_OUTPUTback to summary
public static final StandardLocation NATIVE_HEADER_OUTPUT

Location of new native header files.

Since
1.8
PATCH_MODULE_PATHback to summary
public static final StandardLocation PATCH_MODULE_PATH

Location to search for module patches.

Since
9
PLATFORM_CLASS_PATHback to summary
public static final StandardLocation PLATFORM_CLASS_PATH

Location to search for platform classes. Sometimes called the boot class path.

SOURCE_OUTPUTback to summary
public static final StandardLocation SOURCE_OUTPUT

Location of new source files.

SOURCE_PATHback to summary
public static final StandardLocation SOURCE_PATH

Location to search for existing source files.

SYSTEM_MODULESback to summary
public static final StandardLocation SYSTEM_MODULES

Location to search for system modules.

Since
9
UPGRADE_MODULE_PATHback to summary
public static final StandardLocation UPGRADE_MODULE_PATH

Location to search for upgradeable system modules.

Since
9

Constructor Detail

StandardLocationback to summary
private StandardLocation()

Method Detail

computeIsModuleOrientedLocationback to summary
pack-priv static final boolean computeIsModuleOrientedLocation(String name)
getNameback to summary
public String getName()

Implements javax.tools.JavaFileManager.Location.getName.

Doc from javax.tools.JavaFileManager.Location.getName.

Returns the name of this location.

Annotations
@Override
isModuleOrientedLocationback to summary
public boolean isModuleOrientedLocation()

Overrides default javax.tools.JavaFileManager.Location.isModuleOrientedLocation.

Doc from javax.tools.JavaFileManager.Location.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.

Annotations
@Override
Since
9
isOutputLocationback to summary
public boolean isOutputLocation()

Implements javax.tools.JavaFileManager.Location.isOutputLocation.

Doc from javax.tools.JavaFileManager.Location.isOutputLocation.

Determines if this is an output location. An output location is a location that is conventionally used for output.

Annotations
@Override
locationForback to summary
public static JavaFileManager.Location locationFor(final String 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:String

a name

Returns:JavaFileManager.Location

a location

valueOfback to summary
public static StandardLocation valueOf(String name)
valuesback to summary
public static StandardLocation[] values()
javax.tools back to summary

private Class StandardLocation.LazyPatternHolder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv static final Pattern
MODULE_WORD_PATTERN

Regexp that checks for the word "MODULE".

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

MODULE_WORD_PATTERNback to summary
pack-priv static final Pattern MODULE_WORD_PATTERN

Regexp that checks for the word "MODULE".

Constructor Detail

LazyPatternHolderback to summary
private LazyPatternHolder()