Module java.compiler

Package javax.tools

Enum Class DocumentationTool.Location

java.lang.Object

java.lang.Enum<DocumentationTool.Location>

javax.tools.DocumentationTool.Location

所有已实现的接口:

Serializable, Comparable<DocumentationTool.Location>, Constable, JavaFileManager.Location

封闭接口:

DocumentationTool

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

与 DocumentationTool 相关的位置。

参见:

• StandardLocation

Nested Class Summary

Nested classes/interfaces declared in class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOCLET_PATH	用于搜索文档生成器的位置。
DOCUMENTATION_OUTPUT	新文档文件的位置。
SNIPPET_PATH	用于搜索代码片段的位置。
TAGLET_PATH	用于搜索标签生成器的位置。

Method Summary

Modifier and Type	Method	Description
String	getName()	返回此位置的名称。
boolean	isOutputLocation()	确定这是否为输出位置。
static DocumentationTool.Location	valueOf(String name)	返回具有指定名称的此类的枚举常量。
static DocumentationTool.Location[]	values()	返回包含此枚举类的常量的数组，按声明顺序排列。

Methods declared in class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods declared in class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods declared in interface javax.tools.JavaFileManager.Location

isModuleOrientedLocation

Enum Constant Details

DOCUMENTATION_OUTPUT

             public static final DocumentationTool.Location DOCUMENTATION_OUTPUT
            

新文档文件的位置。

DOCLET_PATH

             public static final DocumentationTool.Location DOCLET_PATH
            

用于搜索文档生成器的位置。

TAGLET_PATH

             public static final DocumentationTool.Location TAGLET_PATH
            

用于搜索标签生成器的位置。

SNIPPET_PATH

             public static final DocumentationTool.Location SNIPPET_PATH
            

用于搜索代码片段的位置。

Method Details

values

             public static DocumentationTool.Location[] values()
            

返回包含此枚举类的常量的数组，按声明顺序排列。

返回:

包含此枚举类的常量的数组，按声明顺序排列

valueOf

             public static DocumentationTool.Location valueOf(String name)
            

返回具有指定名称的此类的枚举常量。字符串必须与此类中用于声明枚举常量的标识符完全匹配。（不允许存在多余的空格字符。）

参数:

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

返回:

具有指定名称的枚举常量

抛出:

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

NullPointerException - 如果参数为null

getName

             public String getName()
            

从接口复制的描述: JavaFileManager.Location

返回此位置的名称。

指定者:

getName 在接口 JavaFileManager.Location

返回:

一个名称

isOutputLocation

             public boolean isOutputLocation()
            

从接口复制的描述: JavaFileManager.Location

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

指定者:

isOutputLocation 在接口 JavaFileManager.Location

返回:

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