Class MapBinding<K,V>

java.lang.Object

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

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

Type Parameters:: K - the type of the key elements; V - the type of the value elements

All Implemented Interfaces:: Map<K,V>, Binding<ObservableMap<K,V>>, Observable, ObservableMapValue<K,V>, ObservableObjectValue<ObservableMap<K,V>>, ObservableValue<ObservableMap<K,V>>, ObservableMap<K,V>

public abstract class MapBinding<K,V>
extends MapExpression<K,V>
implements Binding<ObservableMap<K,V>>

Base class that provides most of the functionality needed to implement a Binding of an ObservableMap.

MapBinding provides a simple invalidation-scheme. An extending class can register dependencies by calling bind(Observable...). If one of the registered dependencies becomes invalid, this MapBinding is marked as invalid. With unbind(Observable...) listening to dependencies can be stopped.

To provide a concrete implementation of this class, the method computeValue() has to be implemented to calculate the value of this binding based on the current state of the dependencies. It is called when get() is called for an invalid binding.

See DoubleBinding for an example how this base class can be extended.

Since:: JavaFX 2.1
See Also:: Binding, MapExpression

Property Summary

Properties declared in class javafx.beans.binding.MapExpression

empty, size

Nested Class Summary

Nested classes/interfaces declared in interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors
Constructor	Description
`MapBinding()`	Creates a default `MapBinding`.

Method Summary

Modifier and Type	Method	Description
`protected void`	`bind(Observable... dependencies)`	Start observing the dependencies for changes.
`protected abstract ObservableMap<K,V>`	`computeValue()`	Calculates the current value of this binding.
`void`	`dispose()`	A default implementation of `dispose()` that is empty.
`ObservableMap<K,V>`	`get()`	Returns the result of `computeValue()`.
`ObservableList<?>`	`getDependencies()`	A default implementation of `getDependencies()` that returns an empty `ObservableList`.
`protected void`	`onInvalidating()`	The method onInvalidating() can be overridden by extending classes to react, if this binding becomes invalid.
`String`	`toString()`	Returns a string representation of this `MapBinding` object.
`protected void`	`unbind(Observable... dependencies)`	Stop observing the dependencies for changes.

Methods declared in class javafx.beans.binding.MapExpression

asString, emptyProperty, getSize, isEqualTo, isNotEqualTo, isNotNull, isNull, mapExpression, sizeProperty, valueAt, valueAt

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods declared in interface javafx.beans.binding.Binding

invalidate, isValid

Methods declared in interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods declared in interface javafx.beans.Observable

addListener, removeListener

Methods declared in interface javafx.collections.ObservableMap

addListener, removeListener

Methods declared in interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Constructor Details

MapBinding

public MapBinding()

Creates a default MapBinding.

Method Details

bind

protected final void bind(Observable... dependencies)

Start observing the dependencies for changes. If the value of one of the dependencies changes, the binding is marked as invalid.

Parameters:: dependencies - the dependencies to observe

unbind

protected final void unbind(Observable... dependencies)

Stop observing the dependencies for changes.

Parameters:: dependencies - the dependencies to stop observing

dispose

public void dispose()

A default implementation of dispose() that is empty.

Specified by:: dispose in interface Binding<K>

getDependencies

public ObservableList<?> getDependencies()

A default implementation of getDependencies() that returns an empty ObservableList.

Specified by:: getDependencies in interface Binding<K>
Returns:: an empty ObservableList

get

public final ObservableMap<K,V> get()

Returns the result of computeValue(). The method computeValue() is only called if the binding is invalid. The result is cached and returned if the binding did not become invalid since the last call of get().

Specified by:: get in interface ObservableObjectValue<K>
Returns:: the current value

onInvalidating

protected void onInvalidating()

The method onInvalidating() can be overridden by extending classes to react, if this binding becomes invalid. The default implementation is empty.

computeValue

protected abstract ObservableMap<K,V> computeValue()

Calculates the current value of this binding.

Classes extending MapBinding have to provide an implementation of computeValue.

Returns:: the current value

toString

public String toString()

Returns a string representation of this MapBinding object.

Overrides:: toString in class Object
Returns:: a string representation of this MapBinding object.

© 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.

Class MapBinding<K,​V>