dev.gradleplugins.documentationkit.dsl.source.model

Class ClassMetaData

java.lang.Object

dev.gradleplugins.documentationkit.dsl.source.model.AbstractLanguageElement

dev.gradleplugins.documentationkit.dsl.source.model.ClassMetaData

All Implemented Interfaces:

LanguageElement, TypeContainer, Attachable<ClassMetaData>, java.io.Serializable

public class ClassMetaData
extends AbstractLanguageElement
implements java.io.Serializable, Attachable<ClassMetaData>, TypeContainer

Static meta-data about a class extracted from the source for the class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassMetaData.MetaType

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.lang.String,java.lang.String>	constants

Constructor Summary

Constructors

Constructor and Description
ClassMetaData(java.lang.String className)
ClassMetaData(java.lang.String className, java.lang.String packageName, ClassMetaData.MetaType metaType, boolean isGroovy, java.lang.String rawClassComment)

Method Summary

Modifier and Type	Method and Description
void	addEnumConstant(java.lang.String name)
void	addImport(java.lang.String importName)
void	addInnerClassName(java.lang.String innerClassName)
void	addInterfaceName(java.lang.String name)
MethodMetaData	addMethod(java.lang.String name, TypeMetaData returnType, java.lang.String rawCommentText)
PropertyMetaData	addReadableProperty(java.lang.String name, TypeMetaData type, java.lang.String rawCommentText, MethodMetaData getterMethod)
PropertyMetaData	addWriteableProperty(java.lang.String name, TypeMetaData type, java.lang.String rawCommentText, MethodMetaData setterMethod)
void	attach(ClassMetaDataRepository<ClassMetaData> metaDataRepository)
MethodMetaData	findDeclaredMethod(java.lang.String signature)
java.util.List<MethodMetaData>	findDeclaredMethods(java.lang.String name)
PropertyMetaData	findDeclaredProperty(java.lang.String name)
PropertyMetaData	findProperty(java.lang.String name) Finds a property by name.
java.lang.String	getClassName()
java.util.Map<java.lang.String,java.lang.String>	getConstants()
java.util.Set<java.lang.String>	getDeclaredMethodNames()
java.util.Set<MethodMetaData>	getDeclaredMethods()
java.util.Set<PropertyMetaData>	getDeclaredProperties()
java.util.Set<java.lang.String>	getDeclaredPropertyNames()
EnumConstantMetaData	getEnumConstant(java.lang.String name)
java.util.List<EnumConstantMetaData>	getEnumConstants()
java.util.List<java.lang.String>	getImports()
java.util.List<java.lang.String>	getInnerClassNames()
java.util.List<java.lang.String>	getInterfaceNames()
java.util.List<ClassMetaData>	getInterfaces()
java.lang.String	getOuterClassName()
java.lang.String	getPackageName()
java.util.Set<java.lang.String>	getPropertyNames() Returns the set of property names for this class, including inherited properties.
java.lang.String	getSimpleName()
ClassMetaData	getSuperClass()
java.lang.String	getSuperClassName()
boolean	isEnum()
boolean	isGroovy()
boolean	isInterface()
void	resolveTypes(org.gradle.api.Transformer<java.lang.String,java.lang.String> transformer)
void	setOuterClassName(java.lang.String outerClassName)
void	setSuperClassName(java.lang.String superClassName)
java.lang.String	toString()
void	visitTypes(org.gradle.api.Action<TypeMetaData> action)

Methods inherited from class dev.gradleplugins.documentationkit.dsl.source.model.AbstractLanguageElement

addAnnotationTypeName, equals, getAnnotationTypeNames, getRawCommentText, getReplacement, hashCode, isDeprecated, isIncubating, isReplaced, setRawCommentText, setReplacement

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

constants

public final java.util.HashMap<java.lang.String,java.lang.String> constants

Constructor Detail

ClassMetaData

public ClassMetaData(java.lang.String className,
                     java.lang.String packageName,
                     ClassMetaData.MetaType metaType,
                     boolean isGroovy,
                     java.lang.String rawClassComment)

ClassMetaData

public ClassMetaData(java.lang.String className)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getClassName

public java.lang.String getClassName()

getSimpleName

public java.lang.String getSimpleName()

getPackageName

public java.lang.String getPackageName()

isInterface

public boolean isInterface()

isGroovy

public boolean isGroovy()

isEnum

public boolean isEnum()

getSuperClassName

public java.lang.String getSuperClassName()

setSuperClassName

public void setSuperClassName(java.lang.String superClassName)

getSuperClass

public ClassMetaData getSuperClass()

getInterfaceNames

public java.util.List<java.lang.String> getInterfaceNames()

addInterfaceName

public void addInterfaceName(java.lang.String name)

getInterfaces

public java.util.List<ClassMetaData> getInterfaces()

getInnerClassNames

public java.util.List<java.lang.String> getInnerClassNames()

addInnerClassName

public void addInnerClassName(java.lang.String innerClassName)

getOuterClassName

public java.lang.String getOuterClassName()

setOuterClassName

public void setOuterClassName(java.lang.String outerClassName)

getImports

public java.util.List<java.lang.String> getImports()

addImport

public void addImport(java.lang.String importName)

addReadableProperty

public PropertyMetaData addReadableProperty(java.lang.String name,
                                            TypeMetaData type,
                                            java.lang.String rawCommentText,
                                            MethodMetaData getterMethod)

addWriteableProperty

public PropertyMetaData addWriteableProperty(java.lang.String name,
                                             TypeMetaData type,
                                             java.lang.String rawCommentText,
                                             MethodMetaData setterMethod)

findDeclaredProperty

public PropertyMetaData findDeclaredProperty(java.lang.String name)

getDeclaredPropertyNames

public java.util.Set<java.lang.String> getDeclaredPropertyNames()

getDeclaredProperties

public java.util.Set<PropertyMetaData> getDeclaredProperties()

getDeclaredMethods

public java.util.Set<MethodMetaData> getDeclaredMethods()

getDeclaredMethodNames

public java.util.Set<java.lang.String> getDeclaredMethodNames()

findDeclaredMethod

public MethodMetaData findDeclaredMethod(java.lang.String signature)

findDeclaredMethods

public java.util.List<MethodMetaData> findDeclaredMethods(java.lang.String name)

findProperty

public PropertyMetaData findProperty(java.lang.String name)

Finds a property by name. Includes inherited properties.

Parameters:

name - The property name.

Returns:

The property, or null if no such property exists.

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames()

Returns the set of property names for this class, including inherited properties.

Returns:

The set of property names.

getConstants

public java.util.Map<java.lang.String,java.lang.String> getConstants()

addEnumConstant

public void addEnumConstant(java.lang.String name)

getEnumConstants

public java.util.List<EnumConstantMetaData> getEnumConstants()

getEnumConstant

public EnumConstantMetaData getEnumConstant(java.lang.String name)

attach

public void attach(ClassMetaDataRepository<ClassMetaData> metaDataRepository)

Specified by:

attach in interface Attachable<ClassMetaData>

addMethod

public MethodMetaData addMethod(java.lang.String name,
                                TypeMetaData returnType,
                                java.lang.String rawCommentText)

resolveTypes

public void resolveTypes(org.gradle.api.Transformer<java.lang.String,java.lang.String> transformer)

Overrides:

resolveTypes in class AbstractLanguageElement

visitTypes

public void visitTypes(org.gradle.api.Action<TypeMetaData> action)

Specified by:

visitTypes in interface TypeContainer