org.springframework.roo.classpath.details

Interface ClassOrInterfaceTypeDetails

All Superinterfaces:

org.springframework.roo.model.CustomDataAccessor, IdentifiableAnnotatedJavaStructure, IdentifiableJavaStructure, MemberHoldingTypeDetails, PhysicalTypeDetails

All Known Implementing Classes:

DefaultClassOrInterfaceTypeDetails

public interface ClassOrInterfaceTypeDetails
extends MemberHoldingTypeDetails

Provides information about the different components of a class, interface or enum.

As per this interface's extension of MemberHoldingTypeDetails, instances of implementing classes must be immutable.

Since:

1.0

Author:

Ben Alex

Method Summary

Modifier and Type	Method and Description
boolean	declaresField(org.springframework.roo.model.JavaSymbolName fieldName) Indicates whether this class or interface declares a field with the given name
List<org.springframework.roo.model.JavaSymbolName>	getEnumConstants() Lists the enum constants this type provides.
Set<ImportMetadata>	getRegisteredImports()
ClassOrInterfaceTypeDetails	getSuperclass() Obtains the superclass if this is a class and it is available.
boolean	isAbstract() Indicates whether this class, interface, or enum is abstract
boolean	isInterface() Indicates whether this element is an interface

Methods inherited from interface org.springframework.roo.classpath.details.MemberHoldingTypeDetails

extendsType, getDeclaredConstructor, getDeclaredConstructors, getDeclaredField, getDeclaredFields, getDeclaredInitializers, getDeclaredInnerType, getDeclaredInnerTypes, getDeclaredMethods, getDynamicFinderNames, getExtendsTypes, getField, getFieldsWithAnnotation, getImplementsTypes, getImports, getLayerEntities, getMethod, getMethod, getMethods, getUniqueFieldName, implementsAny, implementsType

Methods inherited from interface org.springframework.roo.classpath.PhysicalTypeDetails

getName, getPhysicalTypeCategory, getType

Methods inherited from interface org.springframework.roo.classpath.details.IdentifiableAnnotatedJavaStructure

getAnnotation, getAnnotations, getTypeAnnotation

Methods inherited from interface org.springframework.roo.classpath.details.IdentifiableJavaStructure

getDeclaredByMetadataId, getModifier

Methods inherited from interface org.springframework.roo.model.CustomDataAccessor

getCustomData

Method Detail

declaresField

boolean declaresField(org.springframework.roo.model.JavaSymbolName fieldName)

Indicates whether this class or interface declares a field with the given name

Parameters:

fieldName - the field name to check for (can be null)

Returns:

false if a null field name is given

getEnumConstants

List<org.springframework.roo.model.JavaSymbolName> getEnumConstants()

Lists the enum constants this type provides. Always empty except if an enum type.

Returns:

the constants (may be empty, but never null)

getRegisteredImports

Set<ImportMetadata> getRegisteredImports()

Returns:

the explicitly-registered imports this user wishes to have defined in the type (cannot be null, but may be empty)

getSuperclass

ClassOrInterfaceTypeDetails getSuperclass()

Obtains the superclass if this is a class and it is available.

Returns:

the superclass, if available (null will be returned for interfaces, or if the class isn't available)

isAbstract

boolean isAbstract()

Indicates whether this class, interface, or enum is abstract

Returns:

see above

isInterface

boolean isInterface()

Indicates whether this element is an interface

Returns:

see above