org.codehaus.groovy.tools.groovydoc
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

private int	CLASS
private java.lang.String	commentText
private int	definitionType
private java.lang.String	firstSentenceCommentText
private int	INTERFACE
private java.util.List	links
private java.lang.String	name
private java.lang.String	rawCommentText

Constructor Summary

SimpleGroovyDoc(java.lang.String name)

SimpleGroovyDoc(java.lang.String name, java.util.List links)

Method Summary

java.lang.String	commentText()
int	compareTo(java.lang.Object that)
java.lang.String	firstSentenceCommentText()
java.lang.String	getDocUrl(java.lang.String type)
java.lang.String	getRawCommentText()
boolean	isAnnotationType()
boolean	isAnnotationTypeElement()
boolean	isClass()
boolean	isConstructor()
boolean	isEnum()
boolean	isEnumConstant()
boolean	isError()
boolean	isException()
boolean	isField()
boolean	isIncluded()
boolean	isInterface()
boolean	isMethod()
boolean	isOrdinaryClass()
java.lang.String	name()
java.lang.String	replaceAllTags(java.lang.String self, java.lang.String regex, java.lang.String s1, java.lang.String s2)
void	setAsInterfaceDefinition()
void	setRawCommentText(java.lang.String rawCommentText)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

private java.lang.String name

commentText

private java.lang.String commentText

rawCommentText

private java.lang.String rawCommentText

firstSentenceCommentText

private java.lang.String firstSentenceCommentText

links

private java.util.List links

definitionType

private int definitionType

CLASS

private final int CLASS

See Also:

Constant Field Values

INTERFACE

private final int INTERFACE

See Also:

Constant Field Values

Constructor Detail

SimpleGroovyDoc

public SimpleGroovyDoc(java.lang.String name,
                       java.util.List links)

SimpleGroovyDoc

public SimpleGroovyDoc(java.lang.String name)

Method Detail

name

public java.lang.String name()

Specified by:

name in interface GroovyDoc

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

commentText

public java.lang.String commentText()

Specified by:

commentText in interface GroovyDoc

getRawCommentText

public java.lang.String getRawCommentText()

Specified by:

getRawCommentText in interface GroovyDoc

firstSentenceCommentText

public java.lang.String firstSentenceCommentText()

Specified by:

firstSentenceCommentText in interface GroovyDoc

setRawCommentText

public void setRawCommentText(java.lang.String rawCommentText)

Specified by:

setRawCommentText in interface GroovyDoc

replaceAllTags

public java.lang.String replaceAllTags(java.lang.String self,
                                       java.lang.String regex,
                                       java.lang.String s1,
                                       java.lang.String s2)

getDocUrl

public java.lang.String getDocUrl(java.lang.String type)

isClass

public boolean isClass()

Specified by:

isClass in interface GroovyDoc

isInterface

public boolean isInterface()

Specified by:

isInterface in interface GroovyDoc

setAsInterfaceDefinition

public void setAsInterfaceDefinition()

compareTo

public int compareTo(java.lang.Object that)

Specified by:

compareTo in interface java.lang.Comparable

isAnnotationType

public boolean isAnnotationType()

Specified by:

isAnnotationType in interface GroovyDoc

isAnnotationTypeElement

public boolean isAnnotationTypeElement()

Specified by:

isAnnotationTypeElement in interface GroovyDoc

isConstructor

public boolean isConstructor()

Specified by:

isConstructor in interface GroovyDoc

isEnum

public boolean isEnum()

Specified by:

isEnum in interface GroovyDoc

isEnumConstant

public boolean isEnumConstant()

Specified by:

isEnumConstant in interface GroovyDoc

isError

public boolean isError()

Specified by:

isError in interface GroovyDoc

isException

public boolean isException()

Specified by:

isException in interface GroovyDoc

isField

public boolean isField()

Specified by:

isField in interface GroovyDoc

isIncluded

public boolean isIncluded()

Specified by:

isIncluded in interface GroovyDoc

isMethod

public boolean isMethod()

Specified by:

isMethod in interface GroovyDoc

isOrdinaryClass

public boolean isOrdinaryClass()

Specified by:

isOrdinaryClass in interface GroovyDoc