com.holonplatform.core.property

Interface PropertyRendererRegistry

public interface PropertyRendererRegistry

A registry to register PropertyRenderers bound to a condition and provide a suitable PropertyRenderer for a given Property and rendering type.

The registry supports PropertyRenderers priority declaration using Priority annotation on renderer class (where less priority value means higher priority order), to select and return the most suitable renderer where more than one renderer matches the condition to which is bound at registration time.

Since:

5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PropertyRendererRegistry.NoSuitableRendererAvailableException Exception thrown a suitable PropertyRenderer is not available for a given Property and rendering type

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_KEY Default Context resource key

Method Summary

Modifier and Type	Method and Description
static PropertyRendererRegistry	create(boolean loadDefaults) Create a default instance of PropertyRendererRegistry.
default <R,T> void	forProperty(Property<? extends T> property, PropertyRenderer<R,T> renderer) Bind a PropertyRenderer to the given property.
default <R,T,C> void	forPropertyConfiguration(ConfigProperty<C> configurationProperty, C value, PropertyRenderer<R,T> renderer) Bind a PropertyRenderer to the given property configuration value.
static PropertyRendererRegistry	get() Gets the current PropertyRendererRegistry instance.
static PropertyRendererRegistry	getDefault() Return the default PropertyRendererRegistry using default ClassLoader.
static PropertyRendererRegistry	getDefault(ClassLoader classLoader) Return the default PropertyRendererRegistry using given classLoader.
<R,T> Optional<PropertyRenderer<R,T>>	getRenderer(Class<R> renderingType, Property<? extends T> property) Gets the PropertyRenderer to use with given property according to registered renderers for given renderingType.
<R,T> void	register(Predicate<Property<? extends T>> condition, PropertyRenderer<R,T> renderer) Bind a PropertyRenderer to a property Predicate condition.

Field Detail

CONTEXT_KEY

static final String CONTEXT_KEY

Default Context resource key

Method Detail

register

<R,T> void register(Predicate<Property<? extends T>> condition,
                    PropertyRenderer<R,T> renderer)

Bind a PropertyRenderer to a property Predicate condition.

Type Parameters:

R - Rendering type

T - Property base type

Parameters:

condition - The condition which has to be satisfied to provide the renderer (not null)

renderer - The PropertyRenderer to register (not null)

forProperty

default <R,T> void forProperty(Property<? extends T> property,
                               PropertyRenderer<R,T> renderer)

Bind a PropertyRenderer to the given property. The renderer will be provided when the property to render is the same as the given property.

Type Parameters:

R - Rendering type

T - Property base type

Parameters:

property - The property to render (not null)

renderer - The PropertyRenderer to register (not null)

forPropertyConfiguration

default <R,T,C> void forPropertyConfiguration(ConfigProperty<C> configurationProperty,
                                              C value,
                                              PropertyRenderer<R,T> renderer)

Bind a PropertyRenderer to the given property configuration value. The renderer will be provided when the property has the given configurationProperty and its value equals to given value.

Type Parameters:

R - Rendering type

T - Property base type

C - Configuration property type

Parameters:

configurationProperty - The configuration property to check (not null)

value - The configuration property value to check (may be null)

renderer - The PropertyRenderer to register (not null)

getRenderer

<R,T> Optional<PropertyRenderer<R,T>> getRenderer(Class<R> renderingType,
                                                  Property<? extends T> property)

Gets the PropertyRenderer to use with given property according to registered renderers for given renderingType.

Type Parameters:

R - Rendering type

T - Property base type

Parameters:

renderingType - Required rendering type (not null)

property - Property to render (not null)

Returns:

The PropertyRenderer to render given property as given rendering type, or an empty Optional if a suitable renderer is not available

create

static PropertyRendererRegistry create(boolean loadDefaults)

Create a default instance of PropertyRendererRegistry.

Parameters:

loadDefaults - true to load default PropertyRenderers from META-INF/services using com.holonplatform.core.property.PropertyRenderer files using default ClassLoader. Every default renderer will be registered using an always true condition.

Returns:

PropertyRendererRegistry instance

get

static PropertyRendererRegistry get()

Gets the current PropertyRendererRegistry instance.

Returns:

The Context-bound PropertyRendererRegistry instance, if available using CONTEXT_KEY as context key, or the default instance for the default ClassLoader obtained through getDefault().

getDefault

static PropertyRendererRegistry getDefault(ClassLoader classLoader)

Return the default PropertyRendererRegistry using given classLoader.

The default registry is inited loading PropertyRenderers using fully qualified name of its implementation class name to a com.holonplatform.core.property.PropertyRenderer file in the META-INF/services directory.

Parameters:

classLoader - ClassLoader to use

Returns:

Default PropertyRendererRegistry

getDefault

static PropertyRendererRegistry getDefault()

Return the default PropertyRendererRegistry using default ClassLoader.

The default registry is inited loading PropertyRenderers using fully qualified name of its implementation class name to a com.holonplatform.core.property.PropertyRenderer file in the META-INF/services directory.

Returns:

Default PropertyRendererRegistry