public class SimpleGroovyPackageDoc extends SimpleGroovyDoc implements GroovyPackageDoc
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 and Description |
---|
SimpleGroovyPackageDoc(String name) |
Modifier and Type | Method and Description |
---|---|
GroovyClassDoc[] |
allClasses()
All included classes and interfaces in this package.
|
GroovyClassDoc[] |
allClasses(boolean arg0)
All classes and interfaces in this package optionally
limited to just the included ones.
|
String |
description()
Description of the package.
|
GroovyClassDoc[] |
enums()
Included enum types in this package.
|
GroovyClassDoc[] |
errors()
Included errors in this package.
|
GroovyClassDoc[] |
exceptions()
Included exceptions in this package.
|
GroovyClassDoc |
findClass(String arg0)
Find a class or interface within this package.
|
String |
getRelativeRootPath() |
GroovyClassDoc[] |
interfaces()
Included interfaces in this package.
|
String |
nameWithDots() |
GroovyClassDoc[] |
ordinaryClasses()
Included ordinary classes in this package.
|
void |
putAll(Map<String,GroovyClassDoc> classes) |
void |
setDescription(String description) |
void |
setSummary(String summary) |
String |
summary()
The one-sentence summary for the package derived from the beginning of the description.
|
calculateFirstSentence, commentText, compareTo, firstSentenceCommentText, getRawCommentText, getTypeDescription, getTypeSourceDescription, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, isScript, isTrait, name, setCommentText, setDeprecated, setFirstSentenceCommentText, setRawCommentText, setScript, setTokenType, tags, tokenType, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
commentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentText
compareTo
public SimpleGroovyPackageDoc(String name)
public GroovyClassDoc[] allClasses()
GroovyPackageDoc
allClasses
in interface GroovyPackageDoc
public void setDescription(String description)
public void setSummary(String summary)
public void putAll(Map<String,GroovyClassDoc> classes)
public String nameWithDots()
nameWithDots
in interface GroovyPackageDoc
public GroovyClassDoc[] allClasses(boolean arg0)
GroovyPackageDoc
allClasses
in interface GroovyPackageDoc
arg0
- Specifying true filters according to the specified access modifier option.
Specifying false includes all classes and interfaces regardless of access modifier option.public GroovyClassDoc[] enums()
GroovyPackageDoc
enums
in interface GroovyPackageDoc
public GroovyClassDoc[] errors()
GroovyPackageDoc
errors
in interface GroovyPackageDoc
public GroovyClassDoc[] exceptions()
GroovyPackageDoc
exceptions
in interface GroovyPackageDoc
public GroovyClassDoc findClass(String arg0)
GroovyPackageDoc
findClass
in interface GroovyPackageDoc
arg0
- the name of the class to findpublic GroovyClassDoc[] interfaces()
GroovyPackageDoc
interfaces
in interface GroovyPackageDoc
public GroovyClassDoc[] ordinaryClasses()
GroovyPackageDoc
ordinaryClasses
in interface GroovyPackageDoc
public String description()
GroovyPackageDoc
description
in interface GroovyPackageDoc
public String summary()
GroovyPackageDoc
summary
in interface GroovyPackageDoc
public String getRelativeRootPath()
getRelativeRootPath
in interface GroovyPackageDoc