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 Summary
Fields Modifier and Type Field Description static intANNOTATION_DEFstatic intCLASS_DEFstatic intENUM_DEFstatic intINTERFACE_DEFstatic intTRAIT_DEF -
Constructor Summary
Constructors Constructor Description SimpleGroovyDoc(java.lang.String name) -
Method Summary
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()Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
CLASS_DEF
public static final int CLASS_DEF- See Also:
- Constant Field Values
-
TRAIT_DEF
public static final int TRAIT_DEF- See Also:
- Constant Field Values
-
INTERFACE_DEF
public static final int INTERFACE_DEF- See Also:
- Constant Field Values
-
ANNOTATION_DEF
public static final int ANNOTATION_DEF- See Also:
- Constant Field Values
-
ENUM_DEF
public static final int ENUM_DEF- See Also:
- Constant Field Values
-
-
Constructor Details
-
SimpleGroovyDoc
public SimpleGroovyDoc(java.lang.String name)
-
-
Method Details
-
name
public java.lang.String name() -
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) -
isClass
public boolean isClass() -
isScript
public boolean isScript() -
isTrait
public boolean isTrait() -
isInterface
public boolean isInterface()- Specified by:
isInterfacein interfaceGroovyDoc
-
isAnnotationType
public boolean isAnnotationType()- Specified by:
isAnnotationTypein interfaceGroovyDoc
-
isEnum
public boolean isEnum() -
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
-
isError
public boolean isError() -
isException
public boolean isException()- Specified by:
isExceptionin interfaceGroovyDoc
-
isField
public boolean isField() -
isIncluded
public boolean isIncluded()- Specified by:
isIncludedin interfaceGroovyDoc
-
isMethod
public boolean isMethod() -
isOrdinaryClass
public boolean isOrdinaryClass()- Specified by:
isOrdinaryClassin interfaceGroovyDoc
-
tags
-
setDeprecated
public void setDeprecated(boolean deprecated)
-