Class TokenTypesDoclet
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.doclets.TokenTypesDoclet
-
public final class TokenTypesDoclet extends java.lang.Object
Doclet which is used to write property file with short descriptions (first sentences) of TokenTypes' constants. Request: 724871 For ide plugins (like the eclipse plugin) it would be useful to have programmatic access to the first sentence of the TokenType constants, so they can use them in their configuration gui.
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
DEST_FILE_OPT
Command line option to specify file to write output of the doclet.
-
Constructor Summary
Constructors Modifier Constructor Description private
TokenTypesDoclet()
Stop instances being created.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static boolean
checkOptions(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter)
Checks that only valid options was specified.private static java.lang.String
getDestFileName(java.lang.String[]... options)
Reads destination file name.static int
optionLength(java.lang.String option)
Returns option length (how many parts are in option).static boolean
start(com.sun.javadoc.RootDoc root)
The doclet's starter method.
-
-
-
Field Detail
-
DEST_FILE_OPT
private static final java.lang.String DEST_FILE_OPT
Command line option to specify file to write output of the doclet.- See Also:
- Constant Field Values
-
-
Method Detail
-
start
public static boolean start(com.sun.javadoc.RootDoc root) throws java.io.FileNotFoundException
The doclet's starter method.- Parameters:
root
-RootDoc
given to the doclet- Returns:
- true if the given
RootDoc
is processed. - Throws:
java.io.FileNotFoundException
- will be thrown if the doclet will be unable to write to the specified file.
-
optionLength
public static int optionLength(java.lang.String option)
Returns option length (how many parts are in option).- Parameters:
option
- option name to process- Returns:
- option length (how many parts are in option).
-
checkOptions
public static boolean checkOptions(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter)
Checks that only valid options was specified.- Parameters:
options
- all parsed optionsreporter
- the reporter to report errors.- Returns:
- true if only valid options was specified
-
getDestFileName
private static java.lang.String getDestFileName(java.lang.String[]... options)
Reads destination file name.- Parameters:
options
- all specified options.- Returns:
- destination file name
-
-