Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.beehive.controls.api.assembly
Interface ControlAssemblyContext

All Known Implementing Classes:
AppAssemblyContext, BaseAssemblyContext, EJBAssemblyContext, WebAppAssemblyContext
public interface ControlAssemblyContext

Control assemblers are passed a ControlAssemblyContext at the time they are invoked; the context allows the assemblers to interact with their external environment (checking files, side-effecting deployment descriptors, emitting code parameterized by the specifics of the control extension, etc). Beehive provides ControlAssemblyContext implementations that expose the standard environments of J2EE applications and modules. Vendor-specific implementations may provide access to their specific environment information, such as vendor-specific descriptors, via definition and implementation of additional interfaces. ControlAssemblers should use reflection to determine if the ControlAssemblyContext implementation they are passed supports a particular set of environment features.

Nested Class Summary
static interface ControlAssemblyContext.EJBModule
          Providers of ControlAssemblyContext implementations may implement EJBModule to provide access to an EJB module environment.
static interface ControlAssemblyContext.EntAppModule
          Providers of ControlAssemblyContext implementations may implement EntAppModule to provide access to an enterprise application module environment.
static interface ControlAssemblyContext.Factory
          Providers of ControlAssemblyContext implementations MUST implement Factory and newInstance to return their implementation.
static interface ControlAssemblyContext.WebAppModule
          Providers of ControlAssemblyContext implementations may implement WebAppModule to provide access to a webapp module environment.
 
Method Summary
 Set<String> getClients()
           
<T extends Annotation>
T
getControlAnnotation(Class<T> annotationClass)
           
<T extends Annotation>
T
getControlMethodAnnotation(Class<T> annotationClass, Method m)
           
 Class getControlType()
           
 String getDefaultImplClassName()
           
 Messager getMessager()
           
 File getModuleDir()
           
 String getModuleName()
           
 Class getMostDerivedControlInterface()
           
 File getSrcOutputDir()
           
 boolean hasErrors()
           
 

Method Detail

getControlType

Class getControlType()
Returns:
the interface type of the control being assembled (annotated w/ ControlExtension or ControlInterface)

getMostDerivedControlInterface

Class getMostDerivedControlInterface()
Returns:
the most derived interface of the control being assembled that is annotated with ControlInterface (may return the same as getControlType() if the control type is non-extended)

getControlAnnotation

<T extends Annotation> T getControlAnnotation(Class<T> annotationClass)
Returns:
an annotation on the interface returned by getControlType()

getControlMethodAnnotation

<T extends Annotation> T getControlMethodAnnotation(Class<T> annotationClass,
                                                    Method m)
                                                throws NoSuchMethodException
Returns:
an annotation on a method on the interface returned by getControlType()
Throws:
NoSuchMethodException

getDefaultImplClassName

String getDefaultImplClassName()
Returns:
the defaultBinding member of the ControlInterface

getSrcOutputDir

File getSrcOutputDir()
Returns:
the output directory into which "compilable" source should be output.

getModuleDir

File getModuleDir()
Returns:
the root of the module for which assembly is taking place.

getModuleName

String getModuleName()
Returns:
the name of the module for which assembly is taking place.

getClients

Set<String> getClients()
Returns:
the set of clients (by class name) which use the control type

getMessager

Messager getMessager()
Returns:
a Messager implementation that can be used to emit diagnostics during the assembly process.

hasErrors

boolean hasErrors()
Returns:
true if the assembly process reported errors via the Messager
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD