Groovy 2.2.0

org.codehaus.groovy.tools.groovydoc
[Java] Class ExternalGroovyClassDoc

java.lang.Object
  org.codehaus.groovy.tools.groovydoc.ExternalGroovyClassDoc
All Implemented Interfaces:
GroovyClassDoc

public class ExternalGroovyClassDoc
extends Object

Represents a class not in the codebase being processed.


Constructor Summary
ExternalGroovyClassDoc(Class externalClass)

 
Method Summary
GroovyAnnotationRef[] annotations()

String commentText()

int compareTo(Object o)

GroovyConstructorDoc[] constructors()

GroovyConstructorDoc[] constructors(boolean filter)

GroovyClassDoc containingClass()

GroovyPackageDoc containingPackage()

boolean definesSerializableFields()

GroovyFieldDoc[] enumConstants()

boolean equals(Object other)

Class externalClass()

GroovyFieldDoc[] fields()

GroovyFieldDoc[] fields(boolean filter)

GroovyClassDoc findClass(String className)

String firstSentenceCommentText()

String getFullPathName()

String getRawCommentText()

String getRelativeRootPath()

String getTypeSourceDescription()

int hashCode()

GroovyClassDoc[] importedClasses()

GroovyPackageDoc[] importedPackages()

GroovyClassDoc[] innerClasses()

GroovyClassDoc[] innerClasses(boolean filter)

GroovyType[] interfaceTypes()

GroovyClassDoc[] interfaces()

boolean isAbstract()

boolean isAnnotationType()

boolean isAnnotationTypeElement()

boolean isClass()

boolean isConstructor()

boolean isDeprecated()

boolean isEnum()

boolean isEnumConstant()

boolean isError()

boolean isException()

boolean isExternalizable()

boolean isField()

boolean isFinal()

boolean isIncluded()

boolean isInterface()

boolean isMethod()

boolean isOrdinaryClass()

boolean isPackagePrivate()

boolean isPrimitive()

boolean isPrivate()

boolean isProtected()

boolean isPublic()

boolean isSerializable()

boolean isStatic()

GroovyMethodDoc[] methods()

GroovyMethodDoc[] methods(boolean filter)

int modifierSpecifier()

String modifiers()

String name()

GroovyFieldDoc[] properties()

String qualifiedName()

String qualifiedTypeName()

GroovyFieldDoc[] serializableFields()

GroovyMethodDoc[] serializationMethods()

void setRawCommentText(String arg0)

String simpleTypeName()

boolean subclassOf(GroovyClassDoc gcd)

GroovyClassDoc superclass()

GroovyType superclassType()

String typeName()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Constructor Detail

ExternalGroovyClassDoc

public ExternalGroovyClassDoc(Class externalClass)


 
Method Detail

annotations

public GroovyAnnotationRef[] annotations()


commentText

public String commentText()


compareTo

public int compareTo(Object o)


constructors

public GroovyConstructorDoc[] constructors()


constructors

public GroovyConstructorDoc[] constructors(boolean filter)


containingClass

public GroovyClassDoc containingClass()


containingPackage

public GroovyPackageDoc containingPackage()


definesSerializableFields

public boolean definesSerializableFields()


enumConstants

public GroovyFieldDoc[] enumConstants()


equals

@Overrideif (other == this) return true;
public boolean equals(Object other)


externalClass

public Class externalClass()


fields

public GroovyFieldDoc[] fields()


fields

public GroovyFieldDoc[] fields(boolean filter)


findClass

public GroovyClassDoc findClass(String className)


firstSentenceCommentText

public String firstSentenceCommentText()


getFullPathName

public String getFullPathName()


getRawCommentText

public String getRawCommentText()


getRelativeRootPath

public String getRelativeRootPath()


getTypeSourceDescription

public String getTypeSourceDescription()


hashCode

@Overridereturn qualifiedTypeName().hashCode();
public int hashCode()


importedClasses

public GroovyClassDoc[] importedClasses()


importedPackages

public GroovyPackageDoc[] importedPackages()


innerClasses

public GroovyClassDoc[] innerClasses()


innerClasses

public GroovyClassDoc[] innerClasses(boolean filter)


interfaceTypes

public GroovyType[] interfaceTypes()


interfaces

public GroovyClassDoc[] interfaces()


isAbstract

public boolean isAbstract()


isAnnotationType

public boolean isAnnotationType()


isAnnotationTypeElement

public boolean isAnnotationTypeElement()


isClass

public boolean isClass()


isConstructor

public boolean isConstructor()


isDeprecated

public boolean isDeprecated()


isEnum

public boolean isEnum()


isEnumConstant

public boolean isEnumConstant()


isError

public boolean isError()


isException

public boolean isException()


isExternalizable

public boolean isExternalizable()


isField

public boolean isField()


isFinal

public boolean isFinal()


isIncluded

public boolean isIncluded()


isInterface

public boolean isInterface()


isMethod

public boolean isMethod()


isOrdinaryClass

public boolean isOrdinaryClass()


isPackagePrivate

public boolean isPackagePrivate()


isPrimitive

public boolean isPrimitive()


isPrivate

public boolean isPrivate()


isProtected

public boolean isProtected()


isPublic

public boolean isPublic()


isSerializable

public boolean isSerializable()


isStatic

public boolean isStatic()


methods

public GroovyMethodDoc[] methods()


methods

public GroovyMethodDoc[] methods(boolean filter)


modifierSpecifier

public int modifierSpecifier()


modifiers

public String modifiers()


name

public String name()


properties

public GroovyFieldDoc[] properties()


qualifiedName

public String qualifiedName()


qualifiedTypeName

public String qualifiedTypeName()


serializableFields

public GroovyFieldDoc[] serializableFields()


serializationMethods

public GroovyMethodDoc[] serializationMethods()


setRawCommentText

public void setRawCommentText(String arg0)


simpleTypeName

public String simpleTypeName()


subclassOf

public boolean subclassOf(GroovyClassDoc gcd)


superclass

public GroovyClassDoc superclass()


superclassType

public GroovyType superclassType()


typeName

public String typeName()


 

Copyright © 2003-2013 The Codehaus. All rights reserved.