Class ReadOnlyMapWrapper<K,V>

java.lang.Object

javafx.beans.binding.MapExpression<K,V>

javafx.beans.property.ReadOnlyMapProperty<K,V>

javafx.beans.property.MapProperty<K,V>

javafx.beans.property.MapPropertyBase<K,V>

javafx.beans.property.SimpleMapProperty<K,V>

javafx.beans.property.ReadOnlyMapWrapper<K,V>

Type Parameters:

K - the map key type

V - the map value type

All Implemented Interfaces:

Map<K,V>, Observable, Property<ObservableMap<K,V>>, ReadOnlyProperty<ObservableMap<K,V>>, ObservableMapValue<K,V>, ObservableObjectValue<ObservableMap<K,V>>, ObservableValue<ObservableMap<K,V>>, WritableMapValue<K,V>, WritableObjectValue<ObservableMap<K,V>>, WritableValue<ObservableMap<K,V>>, ObservableMap<K,V>

public class ReadOnlyMapWrapper<K,V>
extends SimpleMapProperty<K,V>

This class provides a convenient class to define read-only properties. It creates two properties that are synchronized. One property is read-only and can be passed to external users. The other property is read- and writable and should be used internally only.

Since:

JavaFX 2.1

Nested Class Summary

Nested classes/interfaces declared in interface Map

Map.Entry<K,V>

Property Summary

Properties declared in class MapPropertyBase

empty, size

Type	Property	Description
ReadOnlyBooleanProperty	empty	A boolean property that is true, if the map is empty.
ReadOnlyIntegerProperty	size	An integer property that represents the size of the map.

Constructor Summary

Constructors

Constructor	Description
ReadOnlyMapWrapper()	The constructor of ReadOnlyMapWrapper
ReadOnlyMapWrapper(Object bean, String name)	The constructor of ReadOnlyMapWrapper
ReadOnlyMapWrapper(Object bean, String name, ObservableMap<K,V> initialValue)	The constructor of ReadOnlyMapWrapper
ReadOnlyMapWrapper(ObservableMap<K,V> initialValue)	The constructor of ReadOnlyMapWrapper

Method Summary

Modifier and Type	Method	Description
ReadOnlyMapProperty<K,V>	getReadOnlyProperty()	Returns the readonly property, that is synchronized with this ReadOnlyMapWrapper.

Methods declared in class SimpleMapProperty

getBean, getName

Modifier and Type	Method	Description
Object	getBean()	Returns the Object that contains this property.
String	getName()	Returns the name of this property.

Methods declared in class MapPropertyBase

addListener, addListener, addListener, bind, emptyProperty, fireValueChangedEvent, fireValueChangedEvent, get, invalidated, isBound, removeListener, removeListener, removeListener, set, sizeProperty, toString, unbind

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	addListener(ChangeListener<? super ObservableMap<K,V>> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
void	addListener(MapChangeListener<? super K, ? super V> listener)	Add a listener to this observable map.
void	bind(ObservableValue<? extends ObservableMap<K,V>> newObservable)	Create a unidirection binding for this Property.
ReadOnlyBooleanProperty	emptyProperty()	A boolean property that is true, if the map is empty.
protected void	fireValueChangedEvent()	Sends notifications to all attached InvalidationListeners, ChangeListeners, and MapChangeListener.
protected void	fireValueChangedEvent(MapChangeListener.Change<? extends K, ? extends V> change)	Sends notifications to all attached InvalidationListeners, ChangeListeners, and MapChangeListener.
ObservableMap<K,V>	get()	Returns the current value of this ObservableObjectValue<T>.
protected void	invalidated()	The method invalidated() can be overridden to receive invalidation notifications.
boolean	isBound()	Can be used to check, if a Property is bound.
void	removeListener(InvalidationListener listener)	Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
void	removeListener(ChangeListener<? super ObservableMap<K,V>> listener)	Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.
void	removeListener(MapChangeListener<? super K, ? super V> listener)	Tries to removed a listener from this observable map.
void	set(ObservableMap<K,V> newValue)	Set the wrapped value.
ReadOnlyIntegerProperty	sizeProperty()	An integer property that represents the size of the map.
String	toString()	Returns a string representation of this MapPropertyBase object.
void	unbind()	Remove the unidirectional binding for this Property.

Methods declared in class MapProperty

bindBidirectional, setValue, unbindBidirectional

Modifier and Type	Method	Description
void	bindBidirectional(Property<ObservableMap<K,V>> other)	Create a bidirectional binding between this Property and another one.
void	setValue(ObservableMap<K,V> v)	Set the wrapped value.
void	unbindBidirectional(Property<ObservableMap<K,V>> other)	Removes a bidirectional binding between this Property and another one.

Methods declared in class ReadOnlyMapProperty

bindContent, bindContentBidirectional, equals, hashCode, unbindContent, unbindContentBidirectional

Modifier and Type	Method	Description
void	bindContent(ObservableMap<K,V> map)	Creates a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.
void	bindContentBidirectional(ObservableMap<K,V> map)	Creates a bidirectional content binding of the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.
boolean	equals(Object obj)
int	hashCode()	Returns a hash code for this ReadOnlyMapProperty object.
void	unbindContent(Object object)	Deletes a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.
void	unbindContentBidirectional(Object object)	Deletes a bidirectional content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

Methods declared in class MapExpression

asString, clear, containsKey, containsValue, entrySet, get, getSize, getValue, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, keySet, mapExpression, put, putAll, remove, size, valueAt, valueAt, values

Modifier and Type	Method	Description
StringBinding	asString()	Creates a StringBinding that holds the value of the MapExpression turned into a String.
void	clear()
boolean	containsKey(Object obj)
boolean	containsValue(Object obj)
Set<Map.Entry<K,V>>	entrySet()
V	get(Object key)
int	getSize()	The size of the map
ObservableMap<K,V>	getValue()	Returns the current value of this ObservableValue
boolean	isEmpty()	Gets the value of the empty property.
BooleanBinding	isEqualTo(ObservableMap<?,?> other)	Creates a new BooleanBinding that holds true if this map is equal to another ObservableMap.
BooleanBinding	isNotEqualTo(ObservableMap<?,?> other)	Creates a new BooleanBinding that holds true if this map is not equal to another ObservableMap.
BooleanBinding	isNotNull()	Creates a new BooleanBinding that holds true if the wrapped map is not null.
BooleanBinding	isNull()	Creates a new BooleanBinding that holds true if the wrapped map is null.
Set<K>	keySet()
static <K,V> MapExpression<K,V>	mapExpression(ObservableMapValue<K,V> value)	Returns a MapExpression that wraps a ObservableMapValue.
V	put(K key, V value)
void	putAll(Map<? extends K, ? extends V> elements)
V	remove(Object obj)
int	size()
ObjectBinding<V>	valueAt(ObservableValue<K> key)	Creates a new ObjectBinding that contains the mapping of the specified key.
ObjectBinding<V>	valueAt(K key)	Creates a new ObjectBinding that contains the mapping of the specified key.
Collection<V>	values()

Methods declared in class Object

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

Methods declared in interface Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods declared in interface Observable

subscribe

Modifier and Type	Method	Description
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableValue

flatMap, map, orElse, subscribe, subscribe, when

Modifier and Type	Method	Description
default <U> ObservableValue<U>	flatMap(Function<? super ObservableMap<K,V>, ? extends ObservableValue<? extends U>> mapper)	Returns an ObservableValue that holds the value of an ObservableValue produced by applying the given mapping function on this value.
default <U> ObservableValue<U>	map(Function<? super ObservableMap<K,V>, ? extends U> mapper)	Returns an ObservableValue that holds the result of applying the given mapping function on this value.
default ObservableValue<ObservableMap<K,V>>	orElse(ObservableMap<K,V> constant)	Returns an ObservableValue that holds this value, or the given constant if it is null.
default Subscription	subscribe(BiConsumer<? super ObservableMap<K,V>, ? super ObservableMap<K,V>> changeSubscriber)	Creates a Subscription on this ObservableValue which calls the given changeSubscriber with the old and new value whenever its value changes.
default Subscription	subscribe(Consumer<? super ObservableMap<K,V>> valueSubscriber)	Creates a Subscription on this ObservableValue which immediately provides the current value to the given valueSubscriber, followed by any subsequent values whenever its value changes.
default ObservableValue<ObservableMap<K,V>>	when(ObservableValue<Boolean> condition)	Returns an ObservableValue that holds this value and is updated only when condition holds true.

Methods declared in interface WritableValue

getValue

Modifier and Type	Method	Description
ObservableMap<K,V>	getValue()	Get the wrapped value.

Constructor Details

ReadOnlyMapWrapper

public ReadOnlyMapWrapper()

The constructor of ReadOnlyMapWrapper

ReadOnlyMapWrapper

public ReadOnlyMapWrapper(ObservableMap<K,V> initialValue)

The constructor of ReadOnlyMapWrapper

Parameters:

initialValue - the initial value of the wrapped value

ReadOnlyMapWrapper

public ReadOnlyMapWrapper(Object bean,
 String name)

The constructor of ReadOnlyMapWrapper

Parameters:

bean - the bean of this ReadOnlyMapWrapper

name - the name of this ReadOnlyMapWrapper

ReadOnlyMapWrapper

public ReadOnlyMapWrapper(Object bean,
 String name,
 ObservableMap<K,V> initialValue)

The constructor of ReadOnlyMapWrapper

Parameters:

bean - the bean of this ReadOnlyMapWrapper

name - the name of this ReadOnlyMapWrapper

initialValue - the initial value of the wrapped value

Method Details

getReadOnlyProperty

public ReadOnlyMapProperty<K,V> getReadOnlyProperty()

Returns the readonly property, that is synchronized with this ReadOnlyMapWrapper.

Returns:

the readonly property