compact3

javax.tools

Enum DocumentationTool.Location

java.lang.Object

java.lang.Enum<DocumentationTool.Location>

javax.tools.DocumentationTool.Location

All Implemented Interfaces:

Serializable ， Comparable < DocumentationTool.Location >， JavaFileManager.Location

Enclosing interface:

DocumentationTool

public static enum DocumentationTool.Location
extends Enum<DocumentationTool.Location>
implements JavaFileManager.Location

特定于DocumentationTool的地点 。

另请参见：

StandardLocation

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCLET_PATH 搜索doclets的位置。
DOCUMENTATION_OUTPUT 新文件的位置。
TAGLET_PATH 搜索标签的位置。

方法摘要

Modifier and Type	Method and Description
String	getName() 获取此位置的名称。
boolean	isOutputLocation() 确定这是否是输出位置。
static DocumentationTool.Location	valueOf(String name) 以指定的名称返回此类型的枚举常量。
static DocumentationTool.Location[]	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

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOCUMENTATION_OUTPUT

public static final DocumentationTool.Location DOCUMENTATION_OUTPUT

新文件的位置。

DOCLET_PATH

public static final DocumentationTool.Location DOCLET_PATH

搜索doclets的位置。

TAGLET_PATH

public static final DocumentationTool.Location TAGLET_PATH

搜索标签的位置。

方法详细信息

values

public static DocumentationTool.Location[] values()

按照它们声明的顺序返回一个包含此枚举类型常量的数组。 该方法可用于遍历常量如下：

  for (DocumentationTool.Location c : DocumentationTool.Location.values())
    System.out.println(c); 

结果

一个包含这个枚举类型的常量的数组，按照它们被声明的顺序

valueOf

public static DocumentationTool.Location valueOf(String name)

以指定的名称返回此类型的枚举常量。 字符串必须完全匹配用于声明此类型的枚举常量的标识符。 （不允许使用外来空白字符。）

参数

name - 要返回的枚举常量的名称。

结果

具有指定名称的枚举常数

异常

IllegalArgumentException - 如果此枚举类型没有指定名称的常量

NullPointerException - 如果参数为空

getName

public String getName()

从接口复制： JavaFileManager.Location

获取此位置的名称。

Specified by:

getName在接口 JavaFileManager.Location

结果

一个名字

isOutputLocation

public boolean isOutputLocation()

说明从界面： JavaFileManager.Location复制

确定这是否是输出位置。 输出位置是常规用于输出的位置。

Specified by:

isOutputLocation在接口 JavaFileManager.Location

结果

如果这是输出位置，则为true，否则为false