net.winroad.htmldoclet4jdk7

类 ConfigurationImpl

java.lang.Object

com.sun.tools.doclets.internal.toolkit.Configuration

net.winroad.wrdoclet.AbstractConfiguration

net.winroad.htmldoclet4jdk7.ConfigurationImpl

public class ConfigurationImpl
extends net.winroad.wrdoclet.AbstractConfiguration

Configure the output based on the command line options.

Also determine the length of the command line option. For example,

作者:

Adams Lee

字段概要

字段

限定符和类型	字段和说明
static String	BUILD_DATE The build date.
static String	CONSTANTS_FILE_NAME The name of the constant values file.
boolean	noframe True if command line option "-noframe" is used.
com.sun.tools.doclets.internal.toolkit.util.MessageRetriever	standardmessage Unique Resource Handler for this package.

从类继承的字段 net.winroad.wrdoclet.AbstractConfiguration

authKeyword, branchname, buildid, codeurl, dubboconfigpath, excludedurlsxpath, instance, noAuthKeyword, searchengine, showAnnotationList, springcontextconfigpath, systemname

从类继承的字段 com.sun.tools.doclets.internal.toolkit.Configuration

builderFactory, builderXMLPath, charset, classDocCatalog, copydocfilesubdirs, destDirName, docencoding, docFileDestDirName, DOCLETS_RESOURCE, encoding, excludedDocFileDirs, excludedQualifiers, extern, group, keywords, linksource, message, metakeywords, nocomment, nodeprecated, nosince, notimestamp, packages, root, serialwarn, showauthor, showversion, sourcepath, sourcetab, tagletManager, tagletpath

方法概要

方法

限定符和类型	方法和说明
protected boolean	checkForDeprecation(com.sun.javadoc.RootDoc root)
String	getDocletSpecificBuildDate() Return the build date for the doclet.
com.sun.tools.doclets.internal.toolkit.util.MessageRetriever	getDocletSpecificMsg()
Locale	getLocale()
Comparator<com.sun.javadoc.ProgramElementDoc>	getMemberComparator()
protected com.sun.javadoc.ClassDoc	getValidClass(com.sun.javadoc.ClassDoc[] classarr)
net.winroad.wrdoclet.WRWriterFactory	getWriterFactory()
int	optionLength(String option) Returns the "length" of a given option.
static void	reset() Reset to a fresh new ConfigurationImpl, to allow multiple invocations of javadoc within a single VM.
void	setSpecificDocletOptions(String[][] options) Depending upon the command line options provided by the user, set configure the output generation environment.
boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter reporter)

从类继承的方法 net.winroad.wrdoclet.AbstractConfiguration

getInstance

从类继承的方法 com.sun.tools.doclets.internal.toolkit.Configuration

generalValidOptions, getBuilderFactory, getBuilderXML, getClassName, getJavafxJavadoc, getText, getText, getText, getText, isGeneratedDoc, setOptions, setOptions, shouldExcludeDocFileDir, shouldExcludeQualifier

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

BUILD_DATE

public static final String BUILD_DATE

The build date. Note: For now, we will use a version number instead of a date.

CONSTANTS_FILE_NAME

public static final String CONSTANTS_FILE_NAME

The name of the constant values file.

另请参阅:

常量字段值

noframe

public boolean noframe

True if command line option "-noframe" is used. Default value is false.

standardmessage

public final com.sun.tools.doclets.internal.toolkit.util.MessageRetriever standardmessage

Unique Resource Handler for this package.

方法详细资料

reset

public static void reset()

Reset to a fresh new ConfigurationImpl, to allow multiple invocations of javadoc within a single VM. It would be better not to be using static fields at all, but .... (sigh).

getDocletSpecificBuildDate

public String getDocletSpecificBuildDate()

Return the build date for the doclet.

指定者:

getDocletSpecificBuildDate 在类中 com.sun.tools.doclets.internal.toolkit.Configuration

setSpecificDocletOptions

public void setSpecificDocletOptions(String[][] options)

Depending upon the command line options provided by the user, set configure the output generation environment.

指定者:

setSpecificDocletOptions 在类中 com.sun.tools.doclets.internal.toolkit.Configuration

参数:

options - The array of option names and values.

optionLength

public int optionLength(String option)

Returns the "length" of a given option. If an option takes no arguments, its length is one. If it takes one argument, it's length is two, and so on. This method is called by JavaDoc to parse the options it does not recognize. It then calls validOptions(String[][], DocErrorReporter) to validate them. Note:
The options arrive as case-sensitive strings. For options that are not case-sensitive, use toLowerCase() on the option string before comparing it.

覆盖:

optionLength 在类中 com.sun.tools.doclets.internal.toolkit.Configuration

返回:

number of arguments + 1 for a option. Zero return means option not known. Negative value means error occurred.

validOptions

public boolean validOptions(String[][] options,
                   com.sun.javadoc.DocErrorReporter reporter)

指定者:

validOptions 在类中 com.sun.tools.doclets.internal.toolkit.Configuration

getDocletSpecificMsg

public com.sun.tools.doclets.internal.toolkit.util.MessageRetriever getDocletSpecificMsg()

指定者:

getDocletSpecificMsg 在类中 com.sun.tools.doclets.internal.toolkit.Configuration

getValidClass

protected com.sun.javadoc.ClassDoc getValidClass(com.sun.javadoc.ClassDoc[] classarr)

checkForDeprecation

protected boolean checkForDeprecation(com.sun.javadoc.RootDoc root)

getWriterFactory

public net.winroad.wrdoclet.WRWriterFactory getWriterFactory()

指定者:

getWriterFactory 在类中 com.sun.tools.doclets.internal.toolkit.Configuration

getMemberComparator

public Comparator<com.sun.javadoc.ProgramElementDoc> getMemberComparator()

指定者:

getMemberComparator 在类中 com.sun.tools.doclets.internal.toolkit.Configuration

getLocale

public Locale getLocale()

指定者:

getLocale 在类中 com.sun.tools.doclets.internal.toolkit.Configuration