- java.lang.Object
-
- javafx.beans.binding.MapExpression<K,V>
-
- Type Parameters:
-
K- the type of the key elements -
V- the type of the value elements
- All Implemented Interfaces:
-
Map<K,V>,Observable,ObservableMapValue<K,V>,ObservableObjectValue<ObservableMap<K,V>>,ObservableValue<ObservableMap<K,V>>,ObservableMap<K,V>
- Direct Known Subclasses:
-
MapBinding,ReadOnlyMapProperty
public abstract class MapExpression<K,V> extends Object implements ObservableMapValue<K,V>
MapExpressionis anObservableMapValueplus additional convenience methods to generate bindings in a fluent style.A concrete sub-class of
MapExpressionhas to implement the methodObservableObjectValue.get(), which provides the actual value of this expression.If the wrapped list of a
MapExpressionisnull, all methods implementing theMapinterface will behave as if they were applied to an immutable empty list.- Since:
- JavaFX 2.1
-
Property Summary
Properties Type Property Description abstract ReadOnlyBooleanPropertyemptyA boolean property that istrue, if the map is empty.abstract ReadOnlyIntegerPropertysizeAn integer property that represents the size of the map.
-
Constructor Summary
Constructors Constructor Description MapExpression()
-
Method Summary
All MethodsStatic MethodsInstance MethodsAbstract MethodsConcrete Methods Modifier and Type Method Description StringBindingasString()voidclear()booleancontainsKey(Object obj)booleancontainsValue(Object obj)abstract ReadOnlyBooleanPropertyemptyProperty()A boolean property that istrue, if the map is empty.Set<Map.Entry<K,V>>entrySet()Vget(Object key)intgetSize()The size of the mapObservableMap<K,V>getValue()Returns the current value of thisObservableValuebooleanisEmpty()Gets the value of the property empty.BooleanBindingisEqualTo(ObservableMap<?,?> other)BooleanBindingisNotEqualTo(ObservableMap<?,?> other)BooleanBindingisNotNull()BooleanBindingisNull()Set<K>keySet()static <K,V>
MapExpression<K,V>mapExpression(ObservableMapValue<K,V> value)Returns aMapExpressionthat wraps aObservableMapValue.Vput(K key, V value)voidputAll(Map<? extends K,? extends V> elements)Vremove(Object obj)intsize()abstract ReadOnlyIntegerPropertysizeProperty()An integer property that represents the size of the map.ObjectBinding<V>valueAt(ObservableValue<K> key)Creates a newObjectBindingthat contains the mapping of the specified key.ObjectBinding<V>valueAt(K key)Creates a newObjectBindingthat contains the mapping of the specified key.Collection<V>values()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Methods inherited from interface javafx.beans.Observable
addListener, removeListener
-
Methods inherited from interface javafx.collections.ObservableMap
addListener, removeListener
-
Methods inherited from interface javafx.beans.value.ObservableObjectValue
get
-
Methods inherited from interface javafx.beans.value.ObservableValue
addListener, removeListener
-
-
Property Detail
-
size
public abstract ReadOnlyIntegerProperty sizeProperty
An integer property that represents the size of the map.- See Also:
getSize()
-
empty
public abstract ReadOnlyBooleanProperty emptyProperty
A boolean property that istrue, if the map is empty.- See Also:
isEmpty()
-
-
Constructor Detail
-
MapExpression
public MapExpression()
-
-
Method Detail
-
getValue
public ObservableMap<K,V> getValue()
Description copied from interface:ObservableValueReturns the current value of thisObservableValue- Specified by:
-
getValuein interfaceObservableValue<K> - Returns:
- The current value
-
mapExpression
public static <K,V> MapExpression<K,V> mapExpression(ObservableMapValue<K,V> value)
Returns aMapExpressionthat wraps aObservableMapValue. If theObservableMapValueis already aMapExpression, it will be returned. Otherwise a newMapBindingis created that is bound to theObservableMapValue.- Type Parameters:
-
K- the type of the key elements -
V- the type of the value elements - Parameters:
-
value- The sourceObservableMapValue - Returns:
- A
MapExpressionthat wraps theObservableMapValueif necessary - Throws:
-
NullPointerException- ifvalueisnull
-
getSize
public int getSize()
The size of the map- Returns:
- the size
-
sizeProperty
public abstract ReadOnlyIntegerProperty sizeProperty()
An integer property that represents the size of the map.- See Also:
getSize()
-
emptyProperty
public abstract ReadOnlyBooleanProperty emptyProperty()
A boolean property that istrue, if the map is empty.- See Also:
isEmpty()
-
valueAt
public ObjectBinding<V> valueAt(K key)
Creates a newObjectBindingthat contains the mapping of the specified key.- Parameters:
-
key- the key of the mapping - Returns:
- the
ObjectBinding
-
valueAt
public ObjectBinding<V> valueAt(ObservableValue<K> key)
Creates a newObjectBindingthat contains the mapping of the specified key.- Parameters:
-
key- the key of the mapping - Returns:
- the
ObjectBinding - Throws:
-
NullPointerException- ifkeyisnull
-
isEqualTo
public BooleanBinding isEqualTo(ObservableMap<?,?> other)
- Parameters:
-
other- the otherObservableMap - Returns:
- the new
BooleanBinding - Throws:
-
NullPointerException- ifotherisnull
-
isNotEqualTo
public BooleanBinding isNotEqualTo(ObservableMap<?,?> other)
- Parameters:
-
other- the otherObservableMap - Returns:
- the new
BooleanBinding - Throws:
-
NullPointerException- ifotherisnull
-
isNull
public BooleanBinding isNull()
- Returns:
- the new
BooleanBinding
-
isNotNull
public BooleanBinding isNotNull()
- Returns:
- the new
BooleanBinding
-
asString
public StringBinding asString()
Creates aStringBindingthat holds the value of theMapExpressionturned into aString. If the value of thisMapExpressionchanges, the value of theStringBindingwill be updated automatically.- Returns:
- the new
StringBinding
-
isEmpty
public boolean isEmpty()
Gets the value of the property empty.
-
containsKey
public boolean containsKey(Object obj)
- Specified by:
-
containsKeyin interfaceMap<K,V>
-
containsValue
public boolean containsValue(Object obj)
- Specified by:
-
containsValuein interfaceMap<K,V>
-
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.