Class SimpleGroovyDoc
java.lang.Object
org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
- All Implemented Interfaces:
- java.lang.Comparable,- GroovyDoc
- Direct Known Subclasses:
- SimpleGroovyPackageDoc,- SimpleGroovyProgramElementDoc,- SimpleGroovyRootDoc
public class SimpleGroovyDoc extends java.lang.Object implements GroovyDoc
- 
Field SummaryFields Modifier and Type Field Description static intANNOTATION_DEFstatic intCLASS_DEFstatic intENUM_DEFstatic intINTERFACE_DEFstatic intTRAIT_DEF
- 
Constructor SummaryConstructors Constructor Description SimpleGroovyDoc(java.lang.String name)
- 
Method SummaryModifier 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()Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
- 
Field Details- 
CLASS_DEFpublic static final int CLASS_DEF- See Also:
- Constant Field Values
 
- 
TRAIT_DEFpublic static final int TRAIT_DEF- See Also:
- Constant Field Values
 
- 
INTERFACE_DEFpublic static final int INTERFACE_DEF- See Also:
- Constant Field Values
 
- 
ANNOTATION_DEFpublic static final int ANNOTATION_DEF- See Also:
- Constant Field Values
 
- 
ENUM_DEFpublic static final int ENUM_DEF- See Also:
- Constant Field Values
 
 
- 
- 
Constructor Details- 
SimpleGroovyDocpublic SimpleGroovyDoc(java.lang.String name)
 
- 
- 
Method Details- 
namepublic java.lang.String name()
- 
toStringpublic java.lang.String toString()- Overrides:
- toStringin class- java.lang.Object
 
- 
setCommentTextprotected void setCommentText(java.lang.String commentText)
- 
setFirstSentenceCommentTextprotected void setFirstSentenceCommentText(java.lang.String firstSentenceCommentText)
- 
commentTextpublic java.lang.String commentText()- Specified by:
- commentTextin interface- GroovyDoc
 
- 
firstSentenceCommentTextpublic java.lang.String firstSentenceCommentText()- Specified by:
- firstSentenceCommentTextin interface- GroovyDoc
 
- 
getRawCommentTextpublic java.lang.String getRawCommentText()- Specified by:
- getRawCommentTextin interface- GroovyDoc
 
- 
setRawCommentTextpublic void setRawCommentText(java.lang.String rawCommentText)- Specified by:
- setRawCommentTextin interface- GroovyDoc
 
- 
setScriptpublic void setScript(boolean script)
- 
calculateFirstSentencepublic static java.lang.String calculateFirstSentence(java.lang.String raw)
- 
isClasspublic boolean isClass()
- 
isScriptpublic boolean isScript()
- 
isTraitpublic boolean isTrait()
- 
isInterfacepublic boolean isInterface()- Specified by:
- isInterfacein interface- GroovyDoc
 
- 
isAnnotationTypepublic boolean isAnnotationType()- Specified by:
- isAnnotationTypein interface- GroovyDoc
 
- 
isEnumpublic boolean isEnum()
- 
getTypeDescriptionpublic java.lang.String getTypeDescription()
- 
getTypeSourceDescriptionpublic java.lang.String getTypeSourceDescription()
- 
setTokenTypepublic void setTokenType(int t)
- 
tokenTypepublic int tokenType()
- 
compareTopublic int compareTo(java.lang.Object that)- Specified by:
- compareToin interface- java.lang.Comparable
 
- 
isAnnotationTypeElementpublic boolean isAnnotationTypeElement()- Specified by:
- isAnnotationTypeElementin interface- GroovyDoc
 
- 
isConstructorpublic boolean isConstructor()- Specified by:
- isConstructorin interface- GroovyDoc
 
- 
isEnumConstantpublic boolean isEnumConstant()- Specified by:
- isEnumConstantin interface- GroovyDoc
 
- 
isDeprecatedpublic boolean isDeprecated()- Specified by:
- isDeprecatedin interface- GroovyDoc
 
- 
isErrorpublic boolean isError()
- 
isExceptionpublic boolean isException()- Specified by:
- isExceptionin interface- GroovyDoc
 
- 
isFieldpublic boolean isField()
- 
isIncludedpublic boolean isIncluded()- Specified by:
- isIncludedin interface- GroovyDoc
 
- 
isMethodpublic boolean isMethod()
- 
isOrdinaryClasspublic boolean isOrdinaryClass()- Specified by:
- isOrdinaryClassin interface- GroovyDoc
 
- 
tags
- 
setDeprecatedpublic void setDeprecated(boolean deprecated)
 
-