Enum Constant Detail

• DOCUMENTATION_OUTPUT

  public static final DocumentationTool.Location DOCUMENTATION_OUTPUT

  Location of new documentation files.

• DOCLET_PATH

  public static final DocumentationTool.Location DOCLET_PATH

  Location to search for doclets.

• TAGLET_PATH

  public static final DocumentationTool.Location TAGLET_PATH

  Location to search for taglets.

Method Detail

• values

  public static DocumentationTool.Location[] 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 (DocumentationTool.Location c : DocumentationTool.Location.values())
      System.out.println(c);
  

  Returns:

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

• valueOf

  public static DocumentationTool.Location valueOf(String 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 - if this enum type has no constant with the specified name

  NullPointerException - if the argument is null

• getName

  public String getName()

  Description copied from interface: JavaFileManager.Location
  Gets the name of this location.

  Specified by:

  getName in interface  JavaFileManager.Location

  Returns:

  a name

• isOutputLocation

  public boolean isOutputLocation()

  Description copied from interface: JavaFileManager.Location
  Determines if this is an output location. An output location is a location that is conventionally used for output.

  Specified by:

  isOutputLocation in interface  JavaFileManager.Location

  Returns:

  true if this is an output location, false otherwise