Class SimpleGroovyDoc
- java.lang.Object
-
- org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
-
- All Implemented Interfaces:
java.lang.Comparable,GroovyTokenTypes,GroovyDoc
- Direct Known Subclasses:
SimpleGroovyPackageDoc,SimpleGroovyProgramElementDoc,SimpleGroovyRootDoc
public class SimpleGroovyDoc extends java.lang.Object implements GroovyDoc, GroovyTokenTypes
-
-
Field Summary
-
Fields inherited from interface org.codehaus.groovy.antlr.parser.GroovyTokenTypes
ABSTRACT, ANNOTATION, ANNOTATION_ARRAY_INIT, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, ANNOTATION_MEMBER_VALUE_PAIR, ANNOTATIONS, ARRAY_DECLARATOR, ASSIGN, AT, BAND, BAND_ASSIGN, BIG_SUFFIX, BLOCK, BNOT, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, CASE_GROUP, CLASS_DEF, CLOSABLE_BLOCK, CLOSABLE_BLOCK_OP, CLOSURE_LIST, COLON, COMMA, COMPARE_TO, CTOR_CALL, CTOR_IDENT, DEC, DIGIT, DIGITS_WITH_UNDERSCORE, DIGITS_WITH_UNDERSCORE_OPT, DIV, DIV_ASSIGN, DOLLAR, DOLLAR_REGEXP_CTOR_END, DOLLAR_REGEXP_LITERAL, DOLLAR_REGEXP_SYMBOL, DOT, DYNAMIC_MEMBER, ELIST, ELVIS_OPERATOR, EMPTY_STAT, ENUM_CONSTANT_DEF, ENUM_DEF, EOF, EQUAL, ESC, ESCAPED_DOLLAR, ESCAPED_SLASH, EXPONENT, EXPR, EXTENDS_CLAUSE, FINAL, FLOAT_SUFFIX, FOR_CONDITION, FOR_EACH_CLAUSE, FOR_IN_ITERABLE, FOR_INIT, FOR_ITERATOR, GE, GT, HEX_DIGIT, IDENT, IDENTICAL, IMPLEMENTS_CLAUSE, IMPLICIT_PARAMETERS, IMPORT, INC, INDEX_OP, INSTANCE_INIT, INTERFACE_DEF, LABELED_ARG, LABELED_STAT, LAND, LBRACK, LCURLY, LE, LETTER, LIST_CONSTRUCTOR, LITERAL_as, LITERAL_assert, LITERAL_boolean, LITERAL_break, LITERAL_byte, LITERAL_case, LITERAL_catch, LITERAL_char, LITERAL_class, LITERAL_continue, LITERAL_def, LITERAL_default, LITERAL_double, LITERAL_else, LITERAL_enum, LITERAL_extends, LITERAL_false, LITERAL_finally, LITERAL_float, LITERAL_for, LITERAL_if, LITERAL_implements, LITERAL_import, LITERAL_in, LITERAL_instanceof, LITERAL_int, LITERAL_interface, LITERAL_long, LITERAL_native, LITERAL_new, LITERAL_null, LITERAL_package, LITERAL_private, LITERAL_protected, LITERAL_public, LITERAL_return, LITERAL_short, LITERAL_static, LITERAL_super, LITERAL_switch, LITERAL_synchronized, LITERAL_this, LITERAL_threadsafe, LITERAL_throw, LITERAL_throws, LITERAL_trait, LITERAL_transient, LITERAL_true, LITERAL_try, LITERAL_void, LITERAL_volatile, LITERAL_while, LNOT, LOR, LPAREN, LT, MAP_CONSTRUCTOR, MEMBER_POINTER, METHOD_CALL, METHOD_DEF, MINUS, MINUS_ASSIGN, ML_COMMENT, MOD, MOD_ASSIGN, MODIFIERS, MULTICATCH, MULTICATCH_TYPES, NLS, NOT_EQUAL, NOT_IDENTICAL, NULL_TREE_LOOKAHEAD, NUM_BIG_DECIMAL, NUM_BIG_INT, NUM_DOUBLE, NUM_FLOAT, NUM_INT, NUM_LONG, OBJBLOCK, ONE_NL, OPTIONAL_DOT, PACKAGE_DEF, PARAMETER_DEF, PARAMETERS, PLUS, PLUS_ASSIGN, POST_DEC, POST_INC, QUESTION, RANGE_EXCLUSIVE, RANGE_INCLUSIVE, RBRACK, RCURLY, REGEX_FIND, REGEX_MATCH, REGEXP_CTOR_END, REGEXP_LITERAL, REGEXP_SYMBOL, RPAREN, SELECT_SLOT, SEMI, SH_COMMENT, SL, SL_ASSIGN, SL_COMMENT, SLIST, SPREAD_ARG, SPREAD_DOT, SPREAD_MAP_ARG, SR, SR_ASSIGN, STAR, STAR_ASSIGN, STAR_STAR, STAR_STAR_ASSIGN, STATIC_IMPORT, STATIC_INIT, STRICTFP, STRING_CH, STRING_CONSTRUCTOR, STRING_CTOR_END, STRING_CTOR_MIDDLE, STRING_CTOR_START, STRING_LITERAL, STRING_NL, SUPER_CTOR_CALL, TRAIT_DEF, TRIPLE_DOT, TYPE, TYPE_ARGUMENT, TYPE_ARGUMENTS, TYPE_LOWER_BOUNDS, TYPE_PARAMETER, TYPE_PARAMETERS, TYPE_UPPER_BOUNDS, TYPECAST, UNARY_MINUS, UNARY_PLUS, UNUSED_CONST, UNUSED_DO, UNUSED_GOTO, VARIABLE_DEF, VARIABLE_PARAMETER_DEF, VOCAB, WILDCARD_TYPE, WS
-
-
Constructor Summary
Constructors Constructor Description SimpleGroovyDoc(java.lang.String name)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.lang.StringcalculateFirstSentence(java.lang.String raw)java.lang.StringcommentText()intcompareTo(java.lang.Object that)java.lang.StringfirstSentenceCommentText()java.lang.StringgetRawCommentText()java.lang.StringgetTypeDescription()java.lang.StringgetTypeSourceDescription()booleanisAnnotationType()booleanisAnnotationTypeElement()booleanisClass()booleanisConstructor()booleanisDeprecated()booleanisEnum()booleanisEnumConstant()booleanisError()booleanisException()booleanisField()booleanisIncluded()booleanisInterface()booleanisMethod()booleanisOrdinaryClass()booleanisScript()booleanisTrait()java.lang.Stringname()protected voidsetCommentText(java.lang.String commentText)voidsetDeprecated(boolean deprecated)protected voidsetFirstSentenceCommentText(java.lang.String firstSentenceCommentText)voidsetRawCommentText(java.lang.String rawCommentText)voidsetScript(boolean script)voidsetTokenType(int t)GroovyTag[]tags()inttokenType()java.lang.StringtoString()
-
-
-
Method Detail
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
setCommentText
protected void setCommentText(java.lang.String commentText)
-
setFirstSentenceCommentText
protected void setFirstSentenceCommentText(java.lang.String firstSentenceCommentText)
-
commentText
public java.lang.String commentText()
- Specified by:
commentTextin interfaceGroovyDoc
-
firstSentenceCommentText
public java.lang.String firstSentenceCommentText()
- Specified by:
firstSentenceCommentTextin interfaceGroovyDoc
-
getRawCommentText
public java.lang.String getRawCommentText()
- Specified by:
getRawCommentTextin interfaceGroovyDoc
-
setRawCommentText
public void setRawCommentText(java.lang.String rawCommentText)
- Specified by:
setRawCommentTextin interfaceGroovyDoc
-
setScript
public void setScript(boolean script)
-
calculateFirstSentence
public static java.lang.String calculateFirstSentence(java.lang.String raw)
-
isScript
public boolean isScript()
-
isTrait
public boolean isTrait()
-
isInterface
public boolean isInterface()
- Specified by:
isInterfacein interfaceGroovyDoc
-
isAnnotationType
public boolean isAnnotationType()
- Specified by:
isAnnotationTypein interfaceGroovyDoc
-
getTypeDescription
public java.lang.String getTypeDescription()
-
getTypeSourceDescription
public java.lang.String getTypeSourceDescription()
-
setTokenType
public void setTokenType(int t)
-
tokenType
public int tokenType()
-
compareTo
public int compareTo(java.lang.Object that)
- Specified by:
compareToin interfacejava.lang.Comparable
-
isAnnotationTypeElement
public boolean isAnnotationTypeElement()
- Specified by:
isAnnotationTypeElementin interfaceGroovyDoc
-
isConstructor
public boolean isConstructor()
- Specified by:
isConstructorin interfaceGroovyDoc
-
isEnumConstant
public boolean isEnumConstant()
- Specified by:
isEnumConstantin interfaceGroovyDoc
-
isDeprecated
public boolean isDeprecated()
- Specified by:
isDeprecatedin interfaceGroovyDoc
-
isException
public boolean isException()
- Specified by:
isExceptionin interfaceGroovyDoc
-
isIncluded
public boolean isIncluded()
- Specified by:
isIncludedin interfaceGroovyDoc
-
isOrdinaryClass
public boolean isOrdinaryClass()
- Specified by:
isOrdinaryClassin interfaceGroovyDoc
-
tags
public GroovyTag[] tags()
-
setDeprecated
public void setDeprecated(boolean deprecated)
-
-