org.codefx.libfx.control.properties

Class ControlPropertyListenerBuilder<T>

java.lang.Object

org.codefx.libfx.control.properties.ControlPropertyListenerBuilder<T>

Type Parameters:

T - the type of values which the listener processes

public class ControlPropertyListenerBuilder<T>
extends Object

A builder for a ControlPropertyListener. This is no type on its own as explained in ControlPropertyListenerHandle. Such a handle is returned by this builder.

It is best created by calling ControlProperties.on(ObservableMap) with the control's property map as an argument. It is necessary to set a key (with forKey(Object)) and a processor function for the value (with processValue(Consumer)) before calling buildDetached().

Specifying the value's type with forValueType(Class) is optional. If it is done, the built listener will use it to check the type of the value before casting it to the type accepted by the value processor. If those types do not match, this prevents ClassCastException (which would otherwise be caught and silently ignored). If that case occurs frequently, specifying the type to allow the check will improve performance considerably.

Example

A typical use looks like this:

 ControlProperties.<Boolean> on(control.getProperties())
        .forKey("visible")
        .processValue(this::setVisibility)
        .buildDetached();
 

Method Summary

Modifier and Type	Method and Description
ControlPropertyListenerHandle	buildAttached() Creates a new property listener according to the arguments specified before and attaches it.
ControlPropertyListenerHandle	buildDetached() Creates a new property listener according to the arguments specified before.
ControlPropertyListenerBuilder<T>	forKey(Object key) Sets the key.
ControlPropertyListenerBuilder<T>	forValueType(Class<T> valueType) Sets the type of the values which the built listener will process.
static <T> ControlPropertyListenerBuilder<T>	on(javafx.collections.ObservableMap<Object,Object> properties) Creates a builder for a ControlPropertyListenerHandle which observes the specified property map.
ControlPropertyListenerBuilder<T>	processValue(Consumer<? super T> valueProcessor) Sets the processor for the key's values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

on

public static <T> ControlPropertyListenerBuilder<T> on(javafx.collections.ObservableMap<Object,Object> properties)

Creates a builder for a ControlPropertyListenerHandle which observes the specified property map.

Note that it is often necessary to explicitly specify the type parameter T like so:

 ControlProperties.<String> on(...)
 

Type Parameters:

T - the type of values which the listener processes

Parameters:

properties - the ObservableMap holding the properties

Returns:

a ControlPropertyListenerBuilder

forKey

public ControlPropertyListenerBuilder<T> forKey(Object key)

Sets the key. This must be called before buildDetached().

Parameters:

key - the key the built listener will observe

Returns:

this builder instance for fluent API

forValueType

public ControlPropertyListenerBuilder<T> forValueType(Class<T> valueType)

Sets the type of the values which the built listener will process. Used to type check before calling the valueProcessor.

This type is optional. See the class comment on this builder for details.

Parameters:

valueType - the type of values the built listener will process

Returns:

this builder instance for fluent API

processValue

public ControlPropertyListenerBuilder<T> processValue(Consumer<? super T> valueProcessor)

Sets the processor for the key's values. This must be called before buildAttached().

Parameters:

valueProcessor - the Consumer for the key's values

Returns:

this builder instance for fluent API

buildAttached

public ControlPropertyListenerHandle buildAttached()

Creates a new property listener according to the arguments specified before and attaches it.

Returns:

a ControlPropertyListenerHandle; initially attached

See Also:

buildDetached()

buildDetached

public ControlPropertyListenerHandle buildDetached()

Creates a new property listener according to the arguments specified before.

Note that this builder is not yet attached to the map! This can be done by calling attach() on the returned instance.

Returns:

a ControlPropertyListenerHandle; initially detached

See Also:

buildAttached()