|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<JavadocTagInfo>
com.puppycrawl.tools.checkstyle.api.JavadocTagInfo
public enum JavadocTagInfo
Nested Class Summary | |
---|---|
static class |
JavadocTagInfo.Type
The Javadoc Type. |
Enum Constant Summary | |
---|---|
AUTHOR
@author |
|
CODE
@code} |
|
DEPRECATED
@deprecated |
|
DOC_ROOT
@docRoot} |
|
EXCEPTION
@exception |
|
INHERIT_DOC
@inheritDoc} |
|
LINK
@link} |
|
LINKPLAIN
@linkplain} |
|
LITERAL
@literal} |
|
PARAM
@param |
|
RETURN
@return |
|
SEE
@see |
|
SERIAL
@serial |
|
SERIAL_DATA
@serialData |
|
SERIAL_FIELD
@serialField |
|
SINCE
@since |
|
THROWS
@throws |
|
VALUE
@value} |
|
VERSION
@version |
Method Summary | |
---|---|
static JavadocTagInfo |
fromName(String aName)
returns a JavadocTag from the tag name. |
static JavadocTagInfo |
fromText(String aText)
returns a JavadocTag from the tag text. |
String |
getName()
|
String |
getText()
|
JavadocTagInfo.Type |
getType()
|
boolean |
isValidInOverviewHtml()
Checks if tag is valid in a overview.html Javadoc file. |
boolean |
isValidInPackageHtml()
Checks if tag is valid in a package.html Javadoc file. |
abstract boolean |
isValidOn(DetailAST aAST)
Checks if a particular Javadoc tag is valid within a Javadoc block of a given AST. |
String |
toString()
|
static JavadocTagInfo |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static JavadocTagInfo[] |
values()
Returns an array containing the constants of this enum type, in the order they're declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final JavadocTagInfo AUTHOR
@author.
public static final JavadocTagInfo CODE
@code}.
public static final JavadocTagInfo DOC_ROOT
@docRoot}.
public static final JavadocTagInfo DEPRECATED
@deprecated.
public static final JavadocTagInfo EXCEPTION
@exception.
public static final JavadocTagInfo INHERIT_DOC
@inheritDoc}.
public static final JavadocTagInfo LINK
@link}.
public static final JavadocTagInfo LINKPLAIN
@linkplain}.
public static final JavadocTagInfo LITERAL
@literal}.
public static final JavadocTagInfo PARAM
@param.
public static final JavadocTagInfo RETURN
@return.
public static final JavadocTagInfo SEE
@see.
public static final JavadocTagInfo SERIAL
@serial.
public static final JavadocTagInfo SERIAL_DATA
@serialData.
public static final JavadocTagInfo SERIAL_FIELD
@serialField.
public static final JavadocTagInfo SINCE
@since.
public static final JavadocTagInfo THROWS
@throws.
public static final JavadocTagInfo VALUE
@value}.
public static final JavadocTagInfo VERSION
@version.
Method Detail |
---|
public static final JavadocTagInfo[] values()
for(JavadocTagInfo c : JavadocTagInfo.values()) System.out.println(c);
public static JavadocTagInfo valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified namepublic abstract boolean isValidOn(DetailAST aAST)
For example: Given a call to
JavadocTag.RETURN
.
isValidOn(DetailAST)
If passing in a DetailAST representing a non-void METHOD_DEF
true
would be returned. If passing in a DetailAST
representing a CLASS_DEF false
would be returned because
CLASS_DEF's cannot return a value.
aAST
- the AST representing a type that can be Javadoc'd
public boolean isValidInPackageHtml()
public boolean isValidInOverviewHtml()
public String getText()
public String getName()
public JavadocTagInfo.Type getType()
Type
.public static JavadocTagInfo fromText(String aText)
aText
- String representing the tag text
NullPointerException
- if the text is null
IllegalArgumentException
- if the text is not a valid tagpublic static JavadocTagInfo fromName(String aName)
aName
- String name of the tag
NullPointerException
- if the text is null
IllegalArgumentException
- if the text is not a valid tagpublic String toString()
toString
in class Enum<JavadocTagInfo>
|
Back to the Checkstyle Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |