org.springframework.roo.classpath
Interface PhysicalTypeMetadata

All Superinterfaces:

org.springframework.roo.metadata.MetadataItem

All Known Implementing Classes:

DefaultPhysicalTypeMetadata

public interface PhysicalTypeMetadata
extends org.springframework.roo.metadata.MetadataItem

Represents metadata for a particular PhysicalTypeIdentifierNamingUtils, which is usually a class or interface but may potentially represent an annotation or enum type.

Note that subclasses must support class or interface declarations (ie ClassOrInterfaceTypeDetails), but they may support (at their option) annotation, enumeration and empty types.

PhysicalTypeMetadata may be parsed from source code, parsed from a .class bytecode, or parsed from a .class bytecode from a JAR.

It is important to note a PhysicalTypeMetadata will only include those members explicitly declared in the relevant source or bytecode. This explicitly excludes members introduced via an inter-type declaration (ITD) or other special bytecode modification techniques.

Since:

1.0

Author:

Ben Alex

See Also:

ItdMetadata

Method Summary

String	getItdCanoncialPath(ItdMetadataProvider metadataProvider) Obtains the canoncial file path to where an ITD can be emitted for this physical Java type.
org.springframework.roo.model.JavaType	getItdJavaType(ItdMetadataProvider metadataProvider) Obtains the JavaType which represents an ITD for this physical Java type.
String	getPhysicalLocationCanonicalPath()
PhysicalTypeDetails	getPhysicalTypeDetails()

Methods inherited from interface org.springframework.roo.metadata.MetadataItem

getId, isValid

Method Detail

getPhysicalTypeDetails

PhysicalTypeDetails getPhysicalTypeDetails()

Returns:

the actual details of this physical type, if it could be parsed (may be null if unable to parse)

getPhysicalLocationCanonicalPath

String getPhysicalLocationCanonicalPath()

Returns:

the location of the disk file containing this resource, in canonical name format (never null)

getItdCanoncialPath

String getItdCanoncialPath(ItdMetadataProvider metadataProvider)

Obtains the canoncial file path to where an ITD can be emitted for this physical Java type.

Parameters:

metadataProvider - so the ItdMetadataProvider.getItdUniquenessFilenameSuffix() can be queried (never null)

Returns:

a full file path that can be used to produce an ITD (never null)

getItdJavaType

org.springframework.roo.model.JavaType getItdJavaType(ItdMetadataProvider metadataProvider)

Obtains the JavaType which represents an ITD for this physical Java type.

Parameters:

metadataProvider - so the ItdMetadataProvider.getItdUniquenessFilenameSuffix() can be queried (never null)

Returns:

the JavaType applicable for this ITD (never null)