Class ReadOnlyMapProperty<K,V>

java.lang.Object

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

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

Type Parameters:

K - the type of the key elements of the map

V - the type of the value elements of the map

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>

Direct Known Subclasses:

MapProperty, ReadOnlyMapPropertyBase

public abstract class ReadOnlyMapProperty<K,V>
extends MapExpression<K,V>
implements ReadOnlyProperty<ObservableMap<K,V>>

Superclass for all readonly properties wrapping an ObservableMap.

Since:

JavaFX 2.1

See Also:

• ObservableMap
• ObservableMapValue
• MapExpression
• ReadOnlyProperty

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
ReadOnlyMapProperty()	The constructor of ReadOnlyMapProperty.

Method Summary

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

addListener, removeListener, subscribe

Modifier and Type	Method	Description
void	addListener(InvalidationListener listener)	Adds an InvalidationListener which will be notified whenever the Observable becomes invalid.
void	removeListener(InvalidationListener listener)	Removes the given listener from the list of listeners, that are notified whenever the value of the Observable becomes invalid.
default Subscription	subscribe(Runnable invalidationSubscriber)	Creates a Subscription on this Observable which calls invalidationSubscriber whenever it becomes invalid.

Methods declared in interface ObservableMap

addListener, removeListener

Modifier and Type	Method	Description
void	addListener(MapChangeListener<? super K, ? super V> listener)	Add a listener to this observable map.
void	removeListener(MapChangeListener<? super K, ? super V> listener)	Tries to removed a listener from this observable map.

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

addListener, flatMap, map, orElse, removeListener, subscribe, subscribe, when

Modifier and Type	Method	Description
void	addListener(ChangeListener<? super ObservableMap<K,V>> listener)	Adds a ChangeListener which will be notified whenever the value of the ObservableValue changes.
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.
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.
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

ReadOnlyMapProperty

public ReadOnlyMapProperty()

The constructor of ReadOnlyMapProperty.

Method Details

bindContentBidirectional

public void bindContentBidirectional(ObservableMap<K,V> map)

Creates a bidirectional content binding of the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.

A bidirectional content binding ensures that the content of two ObservableMaps is the same. If the content of one of the maps changes, the other one will be updated automatically.

Parameters:

map - the ObservableMap this property should be bound to

Throws:

NullPointerException - if map is null

IllegalArgumentException - if map is the same map that this ReadOnlyMapProperty points to

unbindContentBidirectional

public void unbindContentBidirectional(Object object)

Deletes a bidirectional content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

Parameters:

object - the Object to which the bidirectional binding should be removed

Throws:

NullPointerException - if object is null

IllegalArgumentException - if object is the same map that this ReadOnlyMapProperty points to

bindContent

public void bindContent(ObservableMap<K,V> map)

Creates a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another ObservableMap.

A content binding ensures that the content of the wrapped ObservableMaps is the same as that of the other map. If the content of the other map changes, the wrapped map will be updated automatically. Once the wrapped list is bound to another map, you must not change it directly.

Parameters:

map - the ObservableMap this property should be bound to

Throws:

NullPointerException - if map is null

IllegalArgumentException - if map is the same map that this ReadOnlyMapProperty points to

unbindContent

public void unbindContent(Object object)

Deletes a content binding between the ObservableMap, that is wrapped in this ReadOnlyMapProperty, and another Object.

Parameters:

object - the Object to which the binding should be removed

Throws:

NullPointerException - if object is null

IllegalArgumentException - if object is the same map that this ReadOnlyMapProperty points to

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code for this ReadOnlyMapProperty object.

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

Returns:

a hash code for this ReadOnlyMapProperty object.

toString

public String toString()

Returns a string representation of this ReadOnlyMapProperty object.

Overrides:

toString in class Object

Returns:

a string representation of this ReadOnlyMapProperty object.