org.jboss.as.ee.component

Interface ComponentView

public interface ComponentView

A component view.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
ManagedReference	createInstance() Create the component view instance.
ManagedReference	createInstance(Map<Object,Object> contextData) Create the component view instance using the additional context data
Component	getComponent() Get the associated component.
Method	getMethod(String name, String descriptor) Gets a view method based on name and descriptor
<T> T	getPrivateData(Class<T> clazz) Provides a mechanism to attach arbitrary data to the component view
Class<?>	getProxyClass()
Class<?>	getViewClass()
Set<Method>	getViewMethods()
Object	invoke(org.jboss.invocation.InterceptorContext interceptorContext) Invoke on the component view interceptor chain.
boolean	isAsynchronous(Method method)

Method Detail

createInstance

ManagedReference createInstance()
                         throws Exception

Create the component view instance.

Returns:

the component view instance

Throws:

Exception

createInstance

ManagedReference createInstance(Map<Object,Object> contextData)
                         throws Exception

Create the component view instance using the additional context data

Parameters:

contextData - Additional context data used in the view creation

Returns:

the component view instance

Throws:

Exception

invoke

Object invoke(org.jboss.invocation.InterceptorContext interceptorContext)
       throws Exception

Invoke on the component view interceptor chain. TODO: fully document the semantics of this method

Parameters:

interceptorContext - The context of the invocation

Returns:

The result of the invocation

Throws:

Exception

getComponent

Component getComponent()

Get the associated component.

Returns:

the component

getProxyClass

Class<?> getProxyClass()

Returns:

The proxy class used in the view

getViewClass

Class<?> getViewClass()

Returns:

The class of the view

getViewMethods

Set<Method> getViewMethods()

Returns:

All methods that the view supports

getMethod

Method getMethod(String name,
                 String descriptor)

Gets a view method based on name and descriptor

Parameters:

name - the method name

descriptor - The method descriptor in JVM format

Returns:

The method that corresponds to the given name and descriptor

Throws:

IllegalArgumentException - If the method cannot be found

getPrivateData

<T> T getPrivateData(Class<T> clazz)

Provides a mechanism to attach arbitrary data to the component view

Parameters:

clazz - The class of attachment

Returns:

The data, or null if it is not present

isAsynchronous

boolean isAsynchronous(Method method)