Module javafx.base
Package javafx.beans.binding

Class MapExpression<K,V>

    • Constructor Detail

      • MapExpression

        public MapExpression​()

    • Method Detail

      • mapExpression

        public static <K,V> MapExpression<K,V> mapExpression​(ObservableMapValue<K,V> value)
        Returns a MapExpression that wraps a 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:
        NullPointerException - if value is null

      • getSize

        public int getSize​()
        The size of the map
        Returns:
        the size

      • 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

      • 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​()
        Description copied from interface: Map
        Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
        Specified by:
        size in interface Map<K,V>
        Returns:
        the number of key-value mappings in this map

      • isEmpty

        public boolean isEmpty​()
        Gets the value of the property empty.
        Specified by:
        isEmpty in interface Map<K,V>
        Property description:
        A boolean property that is true, if the map is empty.
        Returns:
        true if this map contains no key-value mappings

      • containsKey

        public boolean containsKey​(Object obj)
        Description copied from interface: Map
        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.)
        Specified by:
        containsKey in interface Map<K,V>
        Parameters:
        obj - key whose presence in this map is to be tested
        Returns:
        true if this map contains a mapping for the specified key

      • containsValue

        public boolean containsValue​(Object obj)
        Description copied from interface: Map
        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.
        Specified by:
        containsValue in interface Map<K,V>
        Parameters:
        obj - value whose presence in this map is to be tested
        Returns:
        true if this map maps one or more keys to the specified value

      • put

        public V put​(K key,
             V value)
        Description copied from interface: Map
        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.)
        Specified by:
        put in interface Map<K,V>
        Parameters:
        key - key with which the specified value is to be associated
        value - value to be associated with the specified key
        Returns:
        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.)

      • remove

        public V remove​(Object obj)
        Description copied from interface: Map
        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.

        Specified by:
        remove in interface Map<K,V>
        Parameters:
        obj - key whose mapping is to be removed from the map
        Returns:
        the previous value associated with key, or null if there was no mapping for key.

      • putAll

        public void putAll​(Map<? extends K,? extends V> elements)
        Description copied from interface: Map
        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.
        Specified by:
        putAll in interface Map<K,V>
        Parameters:
        elements - mappings to be stored in this map

      • clear

        public void clear​()
        Description copied from interface: Map
        Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
        Specified by:
        clear in interface Map<K,V>

      • keySet

        public Set<K> keySet​()
        Description copied from interface: Map
        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.
        Specified by:
        keySet in interface Map<K,V>
        Returns:
        a set view of the keys contained in this map

      • values

        public Collection<V> values​()
        Description copied from interface: Map
        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.
        Specified by:
        values in interface Map<K,V>
        Returns:
        a collection view of the values contained in this map

      • entrySet

        public Set<Map.Entry<K,V>> entrySet​()
        Description copied from interface: Map
        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.
        Specified by:
        entrySet in interface Map<K,V>
        Returns:
        a set view of the mappings contained in this map

      • get

        public V get​(Object key)
        Description copied from interface: Map
        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.

        Specified by:
        get in interface Map<K,V>
        Parameters:
        key - the key whose associated value is to be returned
        Returns:
        the value to which the specified key is mapped, or null if this map contains no mapping for the key