JavaFX 24 · javafx.beans.binding.MapExpression · APIdia, the JavaDoc alternative

Access	Constructor and Description
public	MapExpression() Creates a default `MapExpression`.

Method Summary

Modifier and Type	Method and Description
public StringBinding	Returns: the new `StringBinding` asString() Creates a `javafx.beans.binding.StringBinding` that holds the value of the `MapExpression` turned into a `String`.
public void	clear() Implements java.util.Map.clear. Removes all of the mappings from this map (optional operation).
public boolean	containsKey(Object key whose presence in this map is to be tested obj) Implements java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key.
public boolean	containsValue(Object value whose presence in this map is to be tested obj) Implements java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value.
public abstract ReadOnlyBooleanProperty	Returns: the `ReadOnlyBooleanProperty` emptyProperty() A boolean property that is `true`, if the map is empty.
public Set<Map.Entry<K, V>>	entrySet() Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.
public V	get(Object the key whose associated value is to be returned key) Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
private ObservableMap<K, V>	getNonNull()
public int	Returns: the size getSize() The size of the map
public ObservableMap<K, V>	getValue() Implements javafx.beans.value.ObservableValue.getValue. Returns the current value of this `ObservableValue`
public boolean	isEmpty() Implements java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.
public BooleanBinding	Returns: the new `BooleanBinding` isEqualTo(final ObservableMap<?, ?> the other `ObservableMap` other) Creates a new `BooleanBinding` that holds `true` if this map is equal to another `javafx.collections.ObservableMap`.
public BooleanBinding	Returns: the new `BooleanBinding` isNotEqualTo(final ObservableMap<?, ?> the other `ObservableMap` other) Creates a new `BooleanBinding` that holds `true` if this map is not equal to another `javafx.collections.ObservableMap`.
public BooleanBinding	Returns: the new `BooleanBinding` isNotNull() Creates a new `BooleanBinding` that holds `true` if the wrapped map is not `null`.
public BooleanBinding	Returns: the new `BooleanBinding` isNull() Creates a new `BooleanBinding` that holds `true` if the wrapped map is `null`.
public Set<K>	keySet() Implements java.util.Map.keySet. Returns a `Set` view of the keys contained in this map.
public static < the type of the key elements K, the type of the value elements V> MapExpression<K, V>	Returns: A `MapExpression` that wraps the `ObservableMapValue` if necessary mapExpression(final ObservableMapValue<K, V> The source `ObservableMapValue` value) Returns a `MapExpression` that wraps a `javafx.beans.value.ObservableMapValue`.
public V	put(K key with which the specified value is to be associated key, V value to be associated with the specified key value) Implements java.util.Map.put. Associates the specified value with the specified key in this map (optional operation).
public void	putAll(Map<? extends K, ? extends V> mappings to be stored in this map elements) Implements java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation).
public V	remove(Object key whose mapping is to be removed from the map obj) Implements java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation).
public int	size() Implements java.util.Map.size. Returns the number of key-value mappings in this map.
public abstract ReadOnlyIntegerProperty	Returns: the property sizeProperty() An integer property that represents the size of the map.
public ObjectBinding<V>	Returns: the `ObjectBinding` valueAt(K the key of the mapping key) Creates a new `ObjectBinding` that contains the mapping of the specified key.
public ObjectBinding<V>	Returns: the `ObjectBinding` valueAt(ObservableValue<K> the key of the mapping key) Creates a new `ObjectBinding` that contains the mapping of the specified key.
public Collection<V>	values() Implements java.util.Map.values. Returns a `Collection` view of the values contained in this map.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

MapExpression	back to summary
public MapExpression() Creates a default `MapExpression`.

Method Detail

asString back to summary

asString	back to summary
public StringBinding asString() Creates a `javafx.beans.binding.StringBinding` that holds the value of the `MapExpression` turned into a `String`. If the value of this `MapExpression` changes, the value of the `StringBinding` will be updated automatically. Returns:StringBinding the new `StringBinding`

public StringBinding asString()

Creates a javafx.beans.binding.StringBinding that holds the value of the MapExpression turned into a String. If the value of this MapExpression changes, the value of the StringBinding will be updated automatically.

Returns:StringBinding: the new StringBinding

clear	back to summary
public void clear() Implements java.util.Map.clear. Doc from java.util.Map.clear. Removes all of the mappings from this map (optional operation). The map will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Annotations

@Override

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object obj) Implements java.util.Map.containsKey. Doc from java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key. More formally, returns `true` if and only if this map contains a mapping for a key `k` such that `Objects.equals(key, k)`. (There can be at most one such mapping.) Parameters obj:Object key whose presence in this map is to be tested Returns:boolean `true` if this map contains a mapping for the specified key Annotations @Override

public boolean containsKey(Object obj)

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters

obj:Object: key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

Annotations

@Override

containsValue back to summary

containsValue	back to summary
public boolean containsValue(Object obj) Implements java.util.Map.containsValue. Doc from java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value. More formally, returns `true` if and only if this map contains at least one mapping to a value `v` such that `Objects.equals(value, v)`. This operation will probably require time linear in the map size for most implementations of the `Map` interface. Parameters obj:Object value whose presence in this map is to be tested Returns:boolean `true` if this map maps one or more keys to the specified value Annotations @Override

public boolean containsValue(Object obj)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters

obj:Object: value whose presence in this map is to be tested

Returns:boolean

true if this map maps one or more keys to the specified value

Annotations

@Override

emptyProperty back to summary

emptyProperty	back to summary
public abstract ReadOnlyBooleanProperty emptyProperty() A boolean property that is `true`, if the map is empty. Returns:ReadOnlyBooleanProperty the `ReadOnlyBooleanProperty`

public abstract ReadOnlyBooleanProperty emptyProperty()

A boolean property that is true, if the map is empty.

Returns:ReadOnlyBooleanProperty: the ReadOnlyBooleanProperty

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<K, V>> entrySet() Implements java.util.Map.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation, or through the `setValue` operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<Map.Entry<K, V>> a set view of the mappings contained in this map Annotations @Override

public Set<Map.Entry<K, V>> entrySet()

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<Map.Entry<K, V>>

a set view of the mappings contained in this map

Annotations

@Override

get back to summary

get	back to summary
public V get(Object key) Implements java.util.Map.get. Doc from java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `Objects.equals(key, k)`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) If this map permits null values, then a return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object the key whose associated value is to be returned Returns:V the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override

public V get(Object key)

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object: the key whose associated value is to be returned

Returns:V

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override

getNonNull	back to summary
private ObservableMap<K, V> getNonNull()

getSize	back to summary
public int getSize() The size of the map Returns:int the size

getSize

back to summary

public int getSize()

The size of the map

Returns:int: the size

getValue back to summary

getValue	back to summary
public ObservableMap<K, V> getValue() Implements javafx.beans.value.ObservableValue.getValue. Doc from javafx.beans.value.ObservableValue.getValue. Returns the current value of this `ObservableValue` Returns:ObservableMap<K, V> The current value Annotations @Override

public ObservableMap<K, V> getValue()

Implements javafx.beans.value.ObservableValue.getValue.

Doc from javafx.beans.value.ObservableValue.getValue.

Returns the current value of this ObservableValue

Returns:ObservableMap<K, V>

The current value

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Map.isEmpty. Doc from java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings. Returns:boolean `true` if this map contains no key-value mappings Annotations @Override

public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean

true if this map contains no key-value mappings

Annotations

@Override

isEqualTo back to summary

isEqualTo	back to summary
public BooleanBinding isEqualTo(final ObservableMap<?, ?> other) Creates a new `BooleanBinding` that holds `true` if this map is equal to another `javafx.collections.ObservableMap`. Parameters other:ObservableMap<?, ?> the other `ObservableMap` Returns:BooleanBinding the new `BooleanBinding` Exceptions NullPointerException: if `other` is `null`

public BooleanBinding isEqualTo(final ObservableMap<?, ?> other)

Creates a new BooleanBinding that holds true if this map is equal to another javafx.collections.ObservableMap.

Parameters

other:ObservableMap<?, ?>: the other ObservableMap

Returns:BooleanBinding

the new BooleanBinding

Exceptions

NullPointerException:: if other is null

isNotEqualTo back to summary

isNotEqualTo	back to summary
public BooleanBinding isNotEqualTo(final ObservableMap<?, ?> other) Creates a new `BooleanBinding` that holds `true` if this map is not equal to another `javafx.collections.ObservableMap`. Parameters other:ObservableMap<?, ?> the other `ObservableMap` Returns:BooleanBinding the new `BooleanBinding` Exceptions NullPointerException: if `other` is `null`

public BooleanBinding isNotEqualTo(final ObservableMap<?, ?> other)

Creates a new BooleanBinding that holds true if this map is not equal to another javafx.collections.ObservableMap.

Parameters

other:ObservableMap<?, ?>: the other ObservableMap

Returns:BooleanBinding

the new BooleanBinding

Exceptions

NullPointerException:: if other is null

isNotNull back to summary

isNotNull	back to summary
public BooleanBinding isNotNull() Creates a new `BooleanBinding` that holds `true` if the wrapped map is not `null`. Returns:BooleanBinding the new `BooleanBinding`

public BooleanBinding isNotNull()

Creates a new BooleanBinding that holds true if the wrapped map is not null.

Returns:BooleanBinding: the new BooleanBinding

isNull back to summary

isNull	back to summary
public BooleanBinding isNull() Creates a new `BooleanBinding` that holds `true` if the wrapped map is `null`. Returns:BooleanBinding the new `BooleanBinding`

public BooleanBinding isNull()

Creates a new BooleanBinding that holds true if the wrapped map is null.

Returns:BooleanBinding: the new BooleanBinding

keySet back to summary

keySet	back to summary
public Set<K> keySet() Implements java.util.Map.keySet. Doc from java.util.Map.keySet. Returns a `Set` view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll`, and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<K> a set view of the keys contained in this map Annotations @Override

public Set<K> keySet()

Implements java.util.Map.keySet.

Doc from java.util.Map.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<K>

a set view of the keys contained in this map

Annotations

@Override

mapExpression back to summary

mapExpression	back to summary
public static <K, V> MapExpression<K, V> mapExpression(final ObservableMapValue<K, V> value) Returns a `MapExpression` that wraps a `javafx.beans.value.ObservableMapValue`. If the `ObservableMapValue` is already a `MapExpression`, it will be returned. Otherwise a new `javafx.beans.binding.MapBinding` is created that is bound to the `ObservableMapValue`. Parameters <K> the type of the key elements <V> the type of the value elements value:ObservableMapValue<K, V> The source `ObservableMapValue` Returns:MapExpression<K, V> A `MapExpression` that wraps the `ObservableMapValue` if necessary Exceptions NullPointerException: if `value` is `null`

public static <K, V> MapExpression<K, V> mapExpression(final ObservableMapValue<K, V> value)

Returns a MapExpression that wraps a javafx.beans.value.ObservableMapValue. If the ObservableMapValue is already a MapExpression, it will be returned. Otherwise a new javafx.beans.binding.MapBinding is created that is bound to the ObservableMapValue.

Parameters

<K>: the type of the key elements
<V>: the type of the value elements
value:ObservableMapValue<K, V>: The source ObservableMapValue

Returns:MapExpression<K, V>

A MapExpression that wraps the ObservableMapValue if necessary

Exceptions

NullPointerException:: if value is null

put back to summary

put	back to summary
public V put(K key, V value) Implements java.util.Map.put. Doc from java.util.Map.put. Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map `m` is said to contain a mapping for a key `k` if and only if `m.containsKey(k)` would return `true`.) Parameters key:K key with which the specified value is to be associated value:V value to be associated with the specified key Returns:V the previous value associated with `key`, or `null` if there was no mapping for `key`. (A `null` return can also indicate that the map previously associated `null` with `key`, if the implementation supports `null` values.) Annotations @Override

public V put(K key, V value)

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters

key:K: key with which the specified value is to be associated
value:V: value to be associated with the specified key

Returns:V

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Annotations

@Override

putAll back to summary

putAll	back to summary
public void putAll(Map<? extends K, ? extends V> elements) Implements java.util.Map.putAll. Doc from java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling `put(k, v)` on this map once for each mapping from key `k` to value `v` in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order. Parameters elements:Map<? extends K, ? extends V> mappings to be stored in this map Annotations @Override

public void putAll(Map<? extends K, ? extends V> elements)

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters

elements:Map<? extends K, ? extends V>: mappings to be stored in this map

Annotations

@Override

remove back to summary

remove	back to summary
public V remove(Object obj) Implements java.util.Map.remove. Doc from java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key `k` to value `v` such that `Objects.equals(key, k)`, that mapping is removed. (The map can contain at most one such mapping.) Returns the value to which this map previously associated the key, or `null` if the map contained no mapping for the key. If this map permits null values, then a return value of `null` does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to `null`. The map will not contain a mapping for the specified key once the call returns. Parameters obj:Object key whose mapping is to be removed from the map Returns:V the previous value associated with `key`, or `null` if there was no mapping for `key`. Annotations @Override

public V remove(Object obj)

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters

obj:Object: key whose mapping is to be removed from the map

Returns:V

the previous value associated with key, or null if there was no mapping for key.

Annotations

@Override

size back to summary

size	back to summary
public int size() Implements java.util.Map.size. Doc from java.util.Map.size. Returns the number of key-value mappings in this map. If the map contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of key-value mappings in this map Annotations @Override

public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of key-value mappings in this map

Annotations

@Override

sizeProperty	back to summary
public abstract ReadOnlyIntegerProperty sizeProperty() An integer property that represents the size of the map. Returns:ReadOnlyIntegerProperty the property

sizeProperty

back to summary

public abstract ReadOnlyIntegerProperty sizeProperty()

An integer property that represents the size of the map.

Returns:ReadOnlyIntegerProperty: the property

valueAt back to summary

valueAt	back to summary
public ObjectBinding<V> valueAt(K key) Creates a new `ObjectBinding` that contains the mapping of the specified key. Parameters key:K the key of the mapping Returns:ObjectBinding<V> the `ObjectBinding`

public ObjectBinding<V> valueAt(K key)

Creates a new ObjectBinding that contains the mapping of the specified key.

Parameters

key:K: the key of the mapping

Returns:ObjectBinding<V>

the ObjectBinding

valueAt back to summary

valueAt	back to summary
public ObjectBinding<V> valueAt(ObservableValue<K> key) Creates a new `ObjectBinding` that contains the mapping of the specified key. Parameters key:ObservableValue<K> the key of the mapping Returns:ObjectBinding<V> the `ObjectBinding` Exceptions NullPointerException: if `key` is `null`

public ObjectBinding<V> valueAt(ObservableValue<K> key)

Creates a new ObjectBinding that contains the mapping of the specified key.

Parameters

key:ObservableValue<K>: the key of the mapping

Returns:ObjectBinding<V>

the ObjectBinding

Exceptions

NullPointerException:: if key is null

values back to summary

values	back to summary
public Collection<V> values() Implements java.util.Map.values. Doc from java.util.Map.values. Returns a `Collection` view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own `remove` operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Collection.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Collection<V> a collection view of the values contained in this map Annotations @Override

public Collection<V> values()

Implements java.util.Map.values.

Doc from java.util.Map.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<V>

a collection view of the values contained in this map

Annotations

@Override

public abstract Class MapExpression<K, V>

Constructor Summary

Method Summary

Constructor Detail

Method Detail