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

Interface ViewConfigResolver

public interface ViewConfigResolver

Resolver for view-configs A ConfigDescriptor can be bound to any config-class (without required base-type). That's needed e.g. for folder-configs. Whereas ViewConfigDescriptors only represent config-classes which inherit from ViewConfig which is required for all page-configs. Use ViewConfigRoot to configure a custom resolver.

Method Summary

Methods

Modifier and Type	Method and Description
ConfigDescriptor<?>	getConfigDescriptor(Class configClass) Resolves the ConfigDescriptor for the given config-class
ConfigDescriptor<?>	getConfigDescriptor(String path)
List<ConfigDescriptor<?>>	getConfigDescriptors() Resolves all descriptors for folders
ViewConfigDescriptor	getDefaultErrorViewConfigDescriptor() Resolves the descriptor for the default-error page
ViewConfigDescriptor	getViewConfigDescriptor(Class<? extends ViewConfig> viewDefinitionClass) Resolves the ViewConfigDescriptor for the given view-config-class
ViewConfigDescriptor	getViewConfigDescriptor(String viewId) Resolves the ViewConfigDescriptor for the given view-id
List<ViewConfigDescriptor>	getViewConfigDescriptors() Resolves all descriptors for the known ViewConfigs

Method Detail

getConfigDescriptor

ConfigDescriptor<?> getConfigDescriptor(String path)

getConfigDescriptor

ConfigDescriptor<?> getConfigDescriptor(Class configClass)

Resolves the ConfigDescriptor for the given config-class

Parameters:

configClass - config-class (which usually represents a folder node)

Returns:

config-descriptor which represents the given config-class

getConfigDescriptors

List<ConfigDescriptor<?>> getConfigDescriptors()

Resolves all descriptors for folders

Returns:

all descriptors for the known view-configs

getViewConfigDescriptor

ViewConfigDescriptor getViewConfigDescriptor(String viewId)

Resolves the ViewConfigDescriptor for the given view-id

Parameters:

viewId - view-id of the page

Returns:

view-config-descriptor which represents the given view-id, null otherwise

getViewConfigDescriptor

ViewConfigDescriptor getViewConfigDescriptor(Class<? extends ViewConfig> viewDefinitionClass)

Resolves the ViewConfigDescriptor for the given view-config-class

Parameters:

viewDefinitionClass - view-config-class of the page

Returns:

view-config-descriptor which represents the given view-config-class

getViewConfigDescriptors

List<ViewConfigDescriptor> getViewConfigDescriptors()

Resolves all descriptors for the known ViewConfigs

Returns:

all descriptors for the known view-configs

getDefaultErrorViewConfigDescriptor

ViewConfigDescriptor getDefaultErrorViewConfigDescriptor()

Resolves the descriptor for the default-error page

Returns:

descriptor for the default-error page