org.apache.deltaspike.core.api.config.view.metadata

Interface ConfigDescriptor<CT>

All Known Subinterfaces:

ViewConfigDescriptor

public interface ConfigDescriptor<CT>

Base descriptor for all type-safe view-configs which represents the config-class and meta-data, callbacks,... provided by/bound to this class.

Method Summary

Methods

Modifier and Type	Method and Description
CallbackDescriptor	getCallbackDescriptor(Class<? extends Annotation> metaDataType) Callbacks which are configured for the entry and bound to the given meta-data type.
CallbackDescriptor	getCallbackDescriptor(Class<? extends Annotation> metaDataType, Class<? extends Annotation> callbackType) Callbacks which are configured for the entry and bound to the given meta-data type.
Class<? extends CT>	getConfigClass()
<T extends ExecutableCallbackDescriptor> T	getExecutableCallbackDescriptor(Class<? extends Annotation> metaDataType, Class<? extends Annotation> callbackType, Class<? extends T> executorType) Callbacks which are configured for the entry and bound to the given meta-data type.
<T extends ExecutableCallbackDescriptor> T	getExecutableCallbackDescriptor(Class<? extends Annotation> metaDataType, Class<? extends T> executorType) Callbacks which are configured for the entry and bound to the given meta-data type.
List<Annotation>	getMetaData() Meta-data which is configured for the entry.
<T extends Annotation> List<T>	getMetaData(Class<T> target) Meta-data which is configured for the entry.
String	getPath() Returns the string representation of the resource represented by #getConfigClass

Method Detail

getConfigClass

Class<? extends CT> getConfigClass()

getMetaData

List<Annotation> getMetaData()

Meta-data which is configured for the entry. It allows to provide and resolve meta-data annotated with ViewMetaData

Returns:

meta-data of the current entry

getMetaData

<T extends Annotation> List<T> getMetaData(Class<T> target)

Meta-data which is configured for the entry. It allows to provide and resolve meta-data annotated with ViewMetaData

Parameters:

target - target type

Returns:

custom meta-data for the given type of the current entry

getCallbackDescriptor

CallbackDescriptor getCallbackDescriptor(Class<? extends Annotation> metaDataType)

Callbacks which are configured for the entry and bound to the given meta-data type.

Parameters:

metaDataType - type of the meta-data (e.g. PageBean.class)

Returns:

descriptor for the callback or null if there is no callback-method

getCallbackDescriptor

CallbackDescriptor getCallbackDescriptor(Class<? extends Annotation> metaDataType,
                                       Class<? extends Annotation> callbackType)

Callbacks which are configured for the entry and bound to the given meta-data type.

Parameters:

metaDataType - type of the meta-data (e.g. PageBean.class)

callbackType - type of the callback (e.g. PreRenderView.class)

Returns:

descriptor for the callback null if there is no callback-method

getExecutableCallbackDescriptor

<T extends ExecutableCallbackDescriptor> T getExecutableCallbackDescriptor(Class<? extends Annotation> metaDataType,
                                                                         Class<? extends T> executorType)

Callbacks which are configured for the entry and bound to the given meta-data type.

Parameters:

metaDataType - type of the meta-data (e.g. PageBean.class)

executorType - type of the executor which allows to get a typed result (e.g. Secured.Descriptor)

Returns:

descriptor for the callback which also allows to invoke it or null if there is no callback-method

getExecutableCallbackDescriptor

<T extends ExecutableCallbackDescriptor> T getExecutableCallbackDescriptor(Class<? extends Annotation> metaDataType,
                                                                         Class<? extends Annotation> callbackType,
                                                                         Class<? extends T> executorType)

Callbacks which are configured for the entry and bound to the given meta-data type.

Parameters:

metaDataType - type of the meta-data (e.g. PageBean.class)

callbackType - type of the callback (e.g. PreRenderView.class)

executorType - type of the executor which allows to get a typed result (e.g. Secured.Descriptor)

Returns:

descriptor for the callback which also allows to invoke it or null if there is no callback-method

getPath

String getPath()

Returns the string representation of the resource represented by #getConfigClass

Returns:

relative path to the folder or page