StandardLocation (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.tools
enum StandardLocation

java.lang.Object
  java.lang.Enum
      javax.tools.StandardLocation

All Implemented Interfaces:: Serializable, Comparable, JavaFileManager.Location

public final enum StandardLocation
extends Enum
implements JavaFileManager.Location

Standard locations of file objects.

Field Summary
`static StandardLocation`	`ANNOTATION_PROCESSOR_PATH` Location to search for annotation processors.
`static StandardLocation`	`CLASS_OUTPUT` Location of new class files.
`static StandardLocation`	`CLASS_PATH` Location to search for user class files.
`static StandardLocation`	`PLATFORM_CLASS_PATH` Location to search for platform classes.
`static StandardLocation`	`SOURCE_OUTPUT` Location of new source files.
`static StandardLocation`	`SOURCE_PATH` Location to search for existing source files.

Method Summary
`String`	`getName()`
`boolean`	`isOutputLocation()`
`static JavaFileManager.Location`	`locationFor(String name)` Gets a location object with the given name.
`static StandardLocation`	`valueOf(String name)`
`static StandardLocation[]`	`values()`

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

ANNOTATION_PROCESSOR_PATH

public static final StandardLocation ANNOTATION_PROCESSOR_PATH

Location to search for annotation processors.

CLASS_OUTPUT

public static final StandardLocation CLASS_OUTPUT

Location of new class files.

CLASS_PATH

public static final StandardLocation CLASS_PATH

Location to search for user class files.

PLATFORM_CLASS_PATH

public static final StandardLocation PLATFORM_CLASS_PATH

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

SOURCE_OUTPUT

public static final StandardLocation SOURCE_OUTPUT

Location of new source files.

SOURCE_PATH

public static final StandardLocation SOURCE_PATH

Location to search for existing source files.

Method Detail

getName

public String getName()

isOutputLocation

public boolean isOutputLocation()

locationFor

public static JavaFileManager.Location locationFor(String name)

Gets a location object with the given name. The following property must hold: {@code locationFor(x) == locationFor(y)} if and only if {@code x.equals(y)}. The returned location will be an output location if and only if name ends with {@code "_OUTPUT"}.

Parameters:: name - a name
Returns:: a location

valueOf

public static StandardLocation valueOf(String name)

Parameters:: name

values

public static StandardLocation[] values()