Module java.compiler
Package javax.tools

Enum Class DocumentationTool.Location

java.lang.Object
java.lang.Enum<DocumentationTool.Location>
javax.tools.DocumentationTool.Location
All Implemented Interfaces:
Serializable, Comparable<DocumentationTool.Location>, Constable, JavaFileManager.Location
Enclosing interface:
DocumentationTool
public static enum DocumentationTool.Location extends Enum<DocumentationTool.Location> implements JavaFileManager.Location
Locations specific to DocumentationTool.
See Also:

  • Enum Constant Details

  • Method Details

    • values

      public static DocumentationTool.Location[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DocumentationTool.Location valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      Description copied from interface: JavaFileManager.Location
      Returns 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