org.springframework.roo.classpath

Interface PhysicalTypeMetadata

All Superinterfaces:

MemberHoldingTypeDetailsMetadataItem<ClassOrInterfaceTypeDetails>, org.springframework.roo.metadata.MetadataItem

All Known Implementing Classes:

DefaultPhysicalTypeMetadata

public interface PhysicalTypeMetadata
extends MemberHoldingTypeDetailsMetadataItem<ClassOrInterfaceTypeDetails>

The metadata for a Java type in the user's project. Excludes any members introduced via an inter-type declaration (ITD) or other bytecode modification technique.

Since:

1.0

Author:

Ben Alex

See Also:

PhysicalTypeMetadataProvider, MemberDetailsScanner

Method Summary

Methods

Modifier and Type	Method and Description
String	getItdCanoncialPath(ItdMetadataProvider metadataProvider) Deprecated. use getItdCanonicalPath(ItdMetadataProvider) instead (fixes typo)
String	getItdCanonicalPath(ItdMetadataProvider metadataProvider) Obtains the canonical 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()
org.springframework.roo.model.JavaType	getType() Returns the Java type for this physical type

Methods inherited from interface org.springframework.roo.classpath.itd.MemberHoldingTypeDetailsMetadataItem

getMemberHoldingTypeDetails

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

getId, isValid

Method Detail

getItdCanoncialPath

@Deprecated
String getItdCanoncialPath(ItdMetadataProvider metadataProvider)

Deprecated. use getItdCanonicalPath(ItdMetadataProvider) instead (fixes typo)

Obtains the canonical 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)

getItdCanonicalPath

String getItdCanonicalPath(ItdMetadataProvider metadataProvider)

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

Parameters:

metadataProvider - the MetadataProvider that produces the ITD in question (never null)

Returns:

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

Since:

1.2.0

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)

getPhysicalLocationCanonicalPath

String getPhysicalLocationCanonicalPath()

Returns:

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

getType

org.springframework.roo.model.JavaType getType()

Returns the Java type for this physical type

Returns:

a non-null type

Since:

1.2.0