JavaFX 24 · com.sun.javafx.collections.UnmodifiableObservableMap

Modifier and Type	Field and Description
private final ObservableMap<K, V>	backingMap
private Set<Map.Entry<K, V>>	entryset
private Set<K>	keyset
private final MapChangeListener<K, V>	listener
private MapListenerHelper<K, V>	listenerHelper
private Collection<V>	values Hides java.util.AbstractMap.values.

Access	Constructor and Description
public	UnmodifiableObservableMap(ObservableMap<K, V> map)

Method Summary

Modifier and Type	Method and Description
public void	addListener(InvalidationListener The listener to register listener) Implements javafx.beans.Observable.addListener. Adds an `InvalidationListener` which will be notified whenever the `Observable` becomes invalid.
public void	addListener(MapChangeListener<? super K, ? super V> the listener for listening to the list changes observer) Implements javafx.collections.ObservableMap.addListener. Add a listener to this observable map.
private void	callObservers(MapChangeListener.Change<? extends K, ? extends V> c)
public boolean	containsKey(Object key whose presence in this map is to be tested key) Overrides java.util.AbstractMap.containsKey. 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 value) Overrides java.util.AbstractMap.containsValue. Implements java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value.
public Set<Map.Entry<K, V>>	entrySet() Implements abstract java.util.AbstractMap.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) Overrides java.util.AbstractMap.get. 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.
public boolean	isEmpty() Overrides java.util.AbstractMap.isEmpty. Implements java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.
public Set<K>	keySet() Overrides java.util.AbstractMap.keySet. Implements java.util.Map.keySet. Returns a `Set` view of the keys contained in this map.
public void	removeListener(InvalidationListener The listener to remove listener) Implements javafx.beans.Observable.removeListener. Removes the given listener from the list of listeners, that are notified whenever the value of the `Observable` becomes invalid.
public void	removeListener(MapChangeListener<? super K, ? super V> a listener to remove observer) Implements javafx.collections.ObservableMap.removeListener. Tries to removed a listener from this observable map.
public int	size() Overrides java.util.AbstractMap.size. Implements java.util.Map.size. Returns the number of key-value mappings in this map.
public Collection<V>	values() Overrides java.util.AbstractMap.values. Implements java.util.Map.values. Returns a `Collection` view of the values contained in this map.

Inherited from java.util.AbstractMap:: clear clone equals hashCode put putAll remove toString

backingMap	back to summary
private final ObservableMap<K, V> backingMap

entryset	back to summary
private Set<Map.Entry<K, V>> entryset

keyset	back to summary
private Set<K> keyset

listener	back to summary
private final MapChangeListener<K, V> listener

listenerHelper	back to summary
private MapListenerHelper<K, V> listenerHelper

values	back to summary
private Collection<V> values Hides java.util.AbstractMap.values.

UnmodifiableObservableMap	back to summary
public UnmodifiableObservableMap(ObservableMap<K, V> map)

Method Detail

addListener back to summary

addListener	back to summary
public void addListener(InvalidationListener listener) Implements javafx.beans.Observable.addListener. Doc from javafx.beans.Observable.addListener. 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:InvalidationListener The listener to register Annotations @Override

public void addListener(InvalidationListener listener)

Implements javafx.beans.Observable.addListener.

Doc from javafx.beans.Observable.addListener.

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:InvalidationListener: The listener to register

Annotations

@Override

addListener	back to summary
public void addListener(MapChangeListener<? super K, ? super V> observer) Implements javafx.collections.ObservableMap.addListener. Doc from javafx.collections.ObservableMap.addListener. Add a listener to this observable map. Parameters observer:MapChangeListener<? super K, ? super V> the listener for listening to the list changes Annotations @Override

addListener

back to summary

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

Implements javafx.collections.ObservableMap.addListener.

Doc from javafx.collections.ObservableMap.addListener.

Add a listener to this observable map.

Parameters

observer:MapChangeListener<? super K, ? super V>: the listener for listening to the list changes

Annotations

@Override

callObservers	back to summary
private void callObservers(MapChangeListener.Change<? extends K, ? extends V> c)

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Overrides java.util.AbstractMap.containsKey. 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 key: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 key)

Overrides java.util.AbstractMap.containsKey.

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

key: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 value) Overrides java.util.AbstractMap.containsValue. 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 value: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 value)

Overrides java.util.AbstractMap.containsValue.

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

value: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

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<K, V>> entrySet() Implements abstract java.util.AbstractMap.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 abstract java.util.AbstractMap.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) Overrides java.util.AbstractMap.get. 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)

Overrides java.util.AbstractMap.get.

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

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Overrides java.util.AbstractMap.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()

Overrides java.util.AbstractMap.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

keySet back to summary

keySet	back to summary
public Set<K> keySet() Overrides java.util.AbstractMap.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()

Overrides java.util.AbstractMap.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

removeListener back to summary

removeListener	back to summary
public void removeListener(InvalidationListener listener) Implements javafx.beans.Observable.removeListener. Doc from javafx.beans.Observable.removeListener. 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:InvalidationListener The listener to remove Annotations @Override

public void removeListener(InvalidationListener listener)

Implements javafx.beans.Observable.removeListener.

Doc from javafx.beans.Observable.removeListener.

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:InvalidationListener: The listener to remove

Annotations

@Override

removeListener	back to summary
public void removeListener(MapChangeListener<? super K, ? super V> observer) Implements javafx.collections.ObservableMap.removeListener. Doc from javafx.collections.ObservableMap.removeListener. Tries to removed a listener from this observable map. If the listener is not attached to this map, nothing happens. Parameters observer:MapChangeListener<? super K, ? super V> a listener to remove Annotations @Override

removeListener

back to summary

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

Implements javafx.collections.ObservableMap.removeListener.

Doc from javafx.collections.ObservableMap.removeListener.

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

Parameters

observer:MapChangeListener<? super K, ? super V>: a listener to remove

Annotations

@Override

size back to summary

size	back to summary
public int size() Overrides java.util.AbstractMap.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()

Overrides java.util.AbstractMap.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

values back to summary

values	back to summary
public Collection<V> values() Overrides java.util.AbstractMap.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()

Overrides java.util.AbstractMap.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 Class UnmodifiableObservableMap<K, V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail