javafx.beans.binding

Class MapExpression<K,V>

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

Direct Known Subclasses:

MapBinding

public abstract class MapExpression<K,V>
extends java.lang.Object

MapExpression is an javafx.beans.value.ObservableMapValue plus additional convenience methods to generate bindings in a fluent style.

A concrete sub-class of MapExpression has to implement the method javafx.beans.value.ObservableMapValue#get(), which provides the actual value of this expression.

If the wrapped list of a MapExpression is null, all methods implementing the Map interface will behave as if they were applied to an immutable empty list.

Since:

JavaFX 2.1

Property Summary

Type	Property and Description
abstract ReadOnlyBooleanProperty	empty A boolean property that is true, if the map is empty.
abstract ReadOnlyIntegerProperty	size An integer property that represents the size of the map.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MapExpression.EmptyObservableMap<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private static ObservableMap	EMPTY_MAP

Constructor Summary

Constructors

Constructor and Description
MapExpression()

Method Summary

Modifier and Type	Method and Description
StringBinding	asString() Creates a StringBinding that holds the value of the MapExpression turned into a String.
void	clear()
boolean	containsKey(java.lang.Object obj)
boolean	containsValue(java.lang.Object obj)
abstract ReadOnlyBooleanProperty	emptyProperty() A boolean property that is true, if the map is empty.
java.util.Set<<any>>	entrySet()
V	get(java.lang.Object key)
int	getSize() The size of the map
<any>	getValue()
boolean	isEmpty() Gets the value of the property empty.
BooleanBinding	isEqualTo(<any> other) Creates a new BooleanBinding that holds true if this map is equal to another javafx.collections.ObservableMap.
BooleanBinding	isNotEqualTo(<any> other) Creates a new BooleanBinding that holds true if this map is not equal to another javafx.collections.ObservableMap.
BooleanBinding	isNotNull() Creates a new BooleanBinding that holds true if the wrapped map is not null.
BooleanBinding	isNull() Creates a new BooleanBinding that holds true if the wrapped map is null.
java.util.Set<K>	keySet()
static <K,V> MapExpression<K,V>	mapExpression(<any> value) Returns a MapExpression that wraps a javafx.beans.value.ObservableMapValue.
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> elements)
V	remove(java.lang.Object obj)
int	size()
abstract ReadOnlyIntegerProperty	sizeProperty() An integer property that represents the size of the map.
ObjectBinding<V>	valueAt(<any> key) Creates a new ObjectBinding that contains the mapping of the specified key.
ObjectBinding<V>	valueAt(K key) Creates a new ObjectBinding that contains the mapping of the specified key.
java.util.Collection<V>	values()

Methods inherited from class java.lang.Object

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

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 is true, if the map is empty.

See Also:

isEmpty()

Field Detail

EMPTY_MAP

private static final ObservableMap EMPTY_MAP

Constructor Detail

MapExpression

public MapExpression()

Method Detail

getValue

public <any> getValue()

mapExpression

public static <K,V> MapExpression<K,V> mapExpression(<any> 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 MapBinding is created that is bound to the ObservableMapValue.

Type Parameters:

K - the type of the key elements

V - the type of the value elements

Parameters:

value - The source ObservableMapValue

Returns:

A MapExpression that wraps the ObservableMapValue if necessary

Throws:

java.lang.NullPointerException - if value is null

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 is true, if the map is empty.

See Also:

isEmpty()

valueAt

public ObjectBinding<V> valueAt(K key)

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

Parameters:

key - the key of the mapping

Returns:

the ObjectBinding

valueAt

public ObjectBinding<V> valueAt(<any> key)

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

Parameters:

key - the key of the mapping

Returns:

the ObjectBinding

Throws:

java.lang.NullPointerException - if key is null

isEqualTo

public BooleanBinding isEqualTo(<any> other)

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

Parameters:

other - the other ObservableMap

Returns:

the new BooleanBinding

Throws:

java.lang.NullPointerException - if other is null

isNotEqualTo

public BooleanBinding isNotEqualTo(<any> other)

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

Parameters:

other - the other ObservableMap

Returns:

the new BooleanBinding

Throws:

java.lang.NullPointerException - if other is null

isNull

public BooleanBinding isNull()

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

Returns:

the new BooleanBinding

isNotNull

public BooleanBinding isNotNull()

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

Returns:

the new BooleanBinding

asString

public StringBinding asString()

Creates a 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:

the new StringBinding

size

public int size()

isEmpty

public boolean isEmpty()

Gets the value of the property empty.

containsKey

public boolean containsKey(java.lang.Object obj)

containsValue

public boolean containsValue(java.lang.Object obj)

put

public V put(K key,
             V value)

remove

public V remove(java.lang.Object obj)

putAll

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

clear

public void clear()

keySet

public java.util.Set<K> keySet()

values

public java.util.Collection<V> values()

entrySet

public java.util.Set<<any>> entrySet()

get

public V get(java.lang.Object key)