Class ReadOnlyMapPropertyBase<K,V>

java.lang.Object

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

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

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

Type Parameters:

K - the map key type

V - the map value type

All Implemented Interfaces:

Map<K,V>, Observable, ReadOnlyProperty<ObservableMap<K,V>>, ObservableMapValue<K,V>, ObservableObjectValue<ObservableMap<K,V>>, ObservableValue<ObservableMap<K,V>>, ObservableMap<K,V>

public abstract class ReadOnlyMapPropertyBase<K,V>
extends ReadOnlyMapProperty<K,V>

Base class for all readonly properties wrapping an ObservableMap. This class provides a default implementation to attach listener.

Since:

JavaFX 2.1

See Also:

• ReadOnlyMapProperty

Nested Class Summary

Nested classes/interfaces declared in interface Map

Map.Entry<K,V>

Property Summary

Properties declared in class MapExpression

empty, size

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

Constructor Summary

Constructors

Constructor	Description
ReadOnlyMapPropertyBase()	Creates a default ReadOnlyMapPropertyBase.

Method Summary

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.
protected void	fireValueChangedEvent()	This method needs to be called if the reference to the ObservableList changes.
protected void	fireValueChangedEvent(MapChangeListener.Change<? extends K, ? extends V> change)	This method needs to be called if the content of the referenced ObservableList changes.
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.

Methods declared in class ReadOnlyMapProperty

bindContent, bindContentBidirectional, equals, hashCode, toString, 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.
String	toString()	Returns a string representation of 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, emptyProperty, entrySet, get, getSize, getValue, isEmpty, isEqualTo, isNotEqualTo, isNotNull, isNull, keySet, mapExpression, put, putAll, remove, size, sizeProperty, 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)
abstract ReadOnlyBooleanProperty	emptyProperty()	A boolean property that is true, if the map is empty.
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()
abstract ReadOnlyIntegerProperty	sizeProperty()	An integer property that represents the size of the map.
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 ObservableObjectValue

get

Modifier and Type	Method	Description
ObservableMap<K,V>	get()	Returns the current value of this ObservableObjectValue<T>.

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 ReadOnlyProperty

getBean, getName

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

Constructor Details

ReadOnlyMapPropertyBase

public ReadOnlyMapPropertyBase()

Creates a default ReadOnlyMapPropertyBase.

Method Details

addListener

public void addListener(InvalidationListener listener)

Description copied from interface: Observable

Adds an InvalidationListener which will be notified whenever the Observable becomes invalid. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.

Note that the same actual InvalidationListener instance may be safely registered for different Observables.

The Observable stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling removeListener after use or to use an instance of WeakInvalidationListener avoid this situation.

Parameters:

listener - The listener to register

See Also:

• Observable.removeListener(InvalidationListener)

removeListener

public void removeListener(InvalidationListener listener)

Description copied from interface: Observable

Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.

If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.

Parameters:

listener - The listener to remove

See Also:

• Observable.addListener(InvalidationListener)

addListener

public void addListener(ChangeListener<? super ObservableMap<K,V>> listener)

Description copied from interface: ObservableValue

Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes. If the same listener is added more than once, then it will be notified more than once. That is, no check is made to ensure uniqueness.

Note that the same actual ChangeListener instance may be safely registered for different ObservableValues.

The ObservableValue stores a strong reference to the listener which will prevent the listener from being garbage collected and may result in a memory leak. It is recommended to either unregister a listener by calling removeListener after use or to use an instance of WeakChangeListener avoid this situation.

Parameters:

listener - The listener to register

See Also:

• ObservableValue.removeListener(ChangeListener)

removeListener

public void removeListener(ChangeListener<? super ObservableMap<K,V>> listener)

Description copied from interface: ObservableValue

Removes the given listener from the list of listeners that are notified whenever the value of the ObservableValue changes.

If the given listener has not been previously registered (i.e. it was never added) then this method call is a no-op. If it had been previously added then it will be removed. If it had been added more than once, then only the first occurrence will be removed.

Parameters:

listener - The listener to remove

See Also:

• ObservableValue.addListener(ChangeListener)

addListener

public void addListener(MapChangeListener<? super K, ? super V> listener)

Description copied from interface: ObservableMap

Add a listener to this observable map.

Parameters:

listener - the listener for listening to the list changes

removeListener

public void removeListener(MapChangeListener<? super K, ? super V> listener)

Description copied from interface: ObservableMap

Tries to removed a listener from this observable map. If the listener is not attached to this map, nothing happens.

Parameters:

listener - a listener to remove

fireValueChangedEvent

protected void fireValueChangedEvent()

This method needs to be called if the reference to the ObservableList changes. It sends notifications to all attached InvalidationListeners, ChangeListeners, and ListChangeListener. This method needs to be called, if the value of this property changes.

fireValueChangedEvent

protected void fireValueChangedEvent(MapChangeListener.Change<? extends K, ? extends V> change)

This method needs to be called if the content of the referenced ObservableList changes. Sends notifications to all attached InvalidationListeners, ChangeListeners, and ListChangeListener. This method is called when the content of the list changes.

Parameters:

change - the change that needs to be propagated