Module javafx.base

Package javafx.beans.property

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<K>, ObservableValue<K>, 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

Property Summary

Properties inherited from class javafx.beans.binding.MapExpression

empty, size

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

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)	Indicates whether some other object is "equal to" this one.
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 inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, entry, forEach, getOrDefault, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from class javafx.beans.binding.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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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, getValue, removeListener

Methods inherited from interface javafx.beans.property.ReadOnlyProperty

getBean, getName

Constructor Detail

ReadOnlyMapProperty

public ReadOnlyMapProperty()

The constructor of ReadOnlyMapProperty.

Method Detail

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)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

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.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.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.