org.gvnix.flex.as.classpath
Interface ASPhysicalTypeMetadataProvider

All Superinterfaces:

org.springframework.roo.metadata.MetadataProvider

All Known Subinterfaces:

ASMutablePhysicalTypeMetadataProvider

All Known Implementing Classes:

As3ParserMetadataProvider

public interface ASPhysicalTypeMetadataProvider
extends org.springframework.roo.metadata.MetadataProvider

MetadataProvider for ActionScript source files.

Author:

Jeremy Grelle

Method Summary

String

findIdentifier(ActionScriptType actionScriptType) Attempts to locate the specified ActionScriptType by searching the physical disk (does not search for existing ASPhysicalTypeMetadata).

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

get, getProvidesType

Method Detail

findIdentifier

String findIdentifier(ActionScriptType actionScriptType)

Attempts to locate the specified ActionScriptType by searching the physical disk (does not search for existing ASPhysicalTypeMetadata).

This method resolves the issue that a ActionScriptType is location independent, yet ASPhysicalTypeIdentifier instances are location dependent (ie a ASPhysicalTypeIdentifier relates to a given physical file, whereas a ActionScriptType simply assumes the type is available from the classpath). This resolution is achieved by first scanning the PathResolver.getSourcePaths() locations, and then scanning any locations provided by the ClasspathProvidingProjectMetadata (if the ProjectMetadata implements this extended interface).

Due to the "best effort" basis of classpath resolution, callers should not rely on complex classpath resolution outcomes. However, callers can rely on robust determination of types defined in Paths from PathResolver.getSourcePaths(), using the Path order returned by that method.

Parameters:

actionScriptType - the type to locate (required)

Returns:

the string (in ASPhysicalTypeIdentifier format) if found, or null if not found