Package Summary  Overview Summary

class:DocumentationTool.Location [NONE]

All Implemented Interfaces:
Serializable, Comparable<DocumentationTool.Location>, Constable, JavaFileManager.Location
Enclosing interface:
DocumentationTool

public static enum DocumentationTool.Locationextends Enum<DocumentationTool.Location> implements JavaFileManager.Location
Locations specific to DocumentationTool.
See Also:

field:DOCUMENTATION_OUTPUT [NONE]

  • DOCUMENTATION_OUTPUT

    public static final  DocumentationTool.Location DOCUMENTATION_OUTPUT
    Location of new documentation files.
  • field:DOCLET_PATH [NONE]

    DOCLET_PATH

    public static final  DocumentationTool.Location DOCLET_PATH
    Location to search for doclets.

    field:TAGLET_PATH [NONE]

    TAGLET_PATH

    public static final  DocumentationTool.Location TAGLET_PATH
    Location to search for taglets.

    field:SNIPPET_PATH [CHANGED]

    SNIPPET_PATH

    public static final  DocumentationTool.Location SNIPPET_PATH
    Location to search for snippets.
    Since:
    18

    SNIPPET_PATH

    public static final  DocumentationTool.Location SNIPPET_PATH
    Location to search for snippets.

    SNIPPET_PATH

    public static final  DocumentationTool.Location SNIPPET_PATH
    Location to search for snippets.
    Since:
    18

    method:values() [NONE]

  • 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
  • method:valueOf(java.lang.String) [NONE]

    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

    method:getName() [NONE]

    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

    method:isOutputLocation() [NONE]

    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