DefaultFunctionMap

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jjoost.collections.maps.wrappers
Class DefaultFunctionMap<K,V>

java.lang.Object
  org.jjoost.collections.maps.wrappers.DefaultFunctionMap<K,V>

All Implemented Interfaces:: java.io.Serializable, AnyMap<K,V>, AnyReadMap<K,V>, Map<K,V>, Function<K,V>

public class DefaultFunctionMap<K,V>
extends java.lang.Object
implements Map<K,V>
extends java.lang.Object
implements Map<K,V>

See Also:: Serialized Form

Constructor Summary
`DefaultFunctionMap(Map<K,V> delegate, Function<K,V> defaultFunction)`

Method Summary
`boolean`	`add(K key, V val)` Attempt to add the pair to the map, returning `false` if it could not be added, and `true` otherwise.
`V`	`apply(K v)` Returns the result of applying the function to the parameter
`int`	`clear()` Clears the map, returning the number of elements removed from it.
`java.util.Iterator<java.util.Map.Entry<K,V>>`	`clearAndReturn()` Clears the map, returning the entries removed from it.
`boolean`	`contains(K key)` Returns true iff a key occurs in the map which is equal to the parameter, as determined by the map's definition of equality.
`boolean`	`contains(K key, V val)` Returns true iff a (key,value) pair occurs in the map that is equal to those provided, as determined by the map's definition(s) of equality.
`Map<K,V>`	`copy()` Returns a copy of the map.
`int`	`count(K key)` Returns the number of occurrences of keys present in the map that are equal to the one provided, as determined by the map's definition of equality.
`int`	`count(K key, V val)` Returns the number of occurrences of (key, value) pairs present in the map that are equal to the one provided, as determined by the map's definition(s) of equality.
`V`	`ensureAndGet(K key, Factory<? extends V> putIfNotPresent)` Equivalent to putIfAbsent(key, putIfNotPresent), except that instead of returning the value previously associated with the key, returns the value associated with the key as the method is exiting; i.e.
`V`	`ensureAndGet(K key, Function<? super K,? extends V> putIfNotPresent)` Equivalent to putIfAbsent(key, putIfNotPresent.create(key)), except that `putIfNotPresent.create()` is only executed if there is no key associated with the value.
`Set<java.util.Map.Entry<K,V>>`	`entries()` Returns a set representing all the key->value pairs in this map.
`java.lang.Iterable<java.util.Map.Entry<K,V>>`	`entries(K key)` Returns an `Iterable` over all key->value maplets in the map whose key is equal to the one provided, as determined by the map's definition of equality.
`V`	`first(K key)` Returns the value associated with the first key that is equal to the one provided, as determined by the map's definition of equality.
`V`	`get(K key)` A convenience method, equivalent to first(key)
`AnyMap<V,K>`	`inverse()` Returns a map representing the inverse function of this map.
`boolean`	`isEmpty()` Returns true iff the map is empty
`Set<K>`	`keys()` Returns a set representing all the keys in the domain of this map.
`java.util.List<V>`	`list(K key)` Returns a `List` of all values in the map which are mapped to by the provided key, as determined by the map's definition of equality.
`boolean`	`permitsDuplicateKeys()` Returns true if a key can map to more than one value
`V`	`put(K key, V val)` Ensures that the provided key binds to the provided value, removing and returning the value currently associated with the key, or null if none.
`V`	`putIfAbsent(K key, Function<? super K,? extends V> putIfNotPresent)` Equivalent to `putIfAbsent(key, putIfNotPresent.create())`, except that `putIfNotPresent.create()` is only executed if there is no key associated with the value.
`V`	`putIfAbsent(K key, V val)` Attempts to bind the provided key to the provided value.
`int`	`remove(K key)` Removes all occurrences of the provided key from domain of the map, returning an integer representing the total number of items removed
`int`	`remove(K key, V val)` Removes all occurrences of the provided key->value pair from the map, returning an integer representing the total number of items removed
`java.lang.Iterable<java.util.Map.Entry<K,V>>`	`removeAndReturn(K key)` Removes all occurrences of the provided key from domain of the map, returning the entries removed
`java.lang.Iterable<java.util.Map.Entry<K,V>>`	`removeAndReturn(K key, V val)` Removes all occurrences of the provided key->value pair from the map, returning the entries removed
`V`	`removeAndReturnFirst(K key)` Removes all occurrences of the provided key from domain of the map, returning the first such value removed, or null if none
`void`	`shrink()` Attempts to make the map use less memory, if possible.
`int`	`size()` A convenience method, equivalent to both `totalCount()` and `uniqueKeyCount()`
`int`	`totalCount()` Return an integer representing the total number of maplets (i.e.
`int`	`uniqueKeyCount()` Return an integer representing the number of unique keys in the domain of the map
`AnySet<V>`	`values()` Returns a set representing the range of the map.
`UnitarySet<V>`	`values(K key)` Returns a set representing the values associated with the provided key in this map.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

DefaultFunctionMap

public DefaultFunctionMap(Map<K,V> delegate,
                          Function<K,V> defaultFunction)

Method Detail

apply

public V apply(K v)

Description copied from interface: Function

Returns the result of applying the function to the parameter

Specified by:: apply in interface Function<K,V>

Parameters:: v - something of type domain
Returns:: the result of the function (something of type range)

clear

public int clear()

Description copied from interface: AnyMap

Clears the map, returning the number of elements removed from it. In a concurrent map, whilst there is no guarantee that the map will be empty when this method returns if it is being concurrently modified, the number will accurately convey the number of items removed.

Specified by:: clear in interface AnyMap<K,V>

Returns:: the int

clearAndReturn

public java.util.Iterator<java.util.Map.Entry<K,V>> clearAndReturn()

Description copied from interface: AnyMap

Clears the map, returning the entries removed from it. In a concurrent map the Iterator will accurately represent the elements that are removed from the map; however the Iterator must be exhausted for the clear operation to be guaranteed to have completed.

Specified by:: clearAndReturn in interface AnyMap<K,V>

Returns:: the iterator< entry< k, v>>

contains

public boolean contains(K key,
                        V val)

Description copied from interface: AnyReadMap

Returns true iff a (key,value) pair occurs in the map that is equal to those provided, as determined by the map's definition(s) of equality.

Specified by:: contains in interface AnyReadMap<K,V>

Parameters:: key - the key; val - the val
Returns:: true, if present

contains

public boolean contains(K key)

Description copied from interface: AnyReadMap

Returns true iff a key occurs in the map which is equal to the parameter, as determined by the map's definition of equality.

Specified by:: contains in interface AnyReadMap<K,V>

Parameters:: key - find
Returns:: true, if present

copy

public Map<K,V> copy()

Description copied from interface: AnyMap

Returns a copy of the map. Note that this method may not necessarily return an object of the same class as the one it is called upon, but will return one indistinguishable from it with respect to all method calls.

Specified by:: copy in interface AnyMap<K,V>
Specified by:: copy in interface Map<K,V>

Returns:: the any map< k, v>

count

public int count(K key,
                 V val)

Description copied from interface: AnyReadMap

Returns the number of occurrences of (key, value) pairs present in the map that are equal to the one provided, as determined by the map's definition(s) of equality.

Specified by:: count in interface AnyReadMap<K,V>

Parameters:: key - the key; val - the val
Returns:: number of occurrences

count

public int count(K key)

Description copied from interface: AnyReadMap

Returns the number of occurrences of keys present in the map that are equal to the one provided, as determined by the map's definition of equality.

Specified by:: count in interface AnyReadMap<K,V>

Parameters:: key - the key
Returns:: number of occurrences

ensureAndGet

public V ensureAndGet(K key,
                      Factory<? extends V> putIfNotPresent)

Description copied from interface: Map

Equivalent to putIfAbsent(key, putIfNotPresent), except that instead of returning the value previously associated with the key, returns the value associated with the key as the method is exiting; i.e. if a new value is associated with the key as a result of this method, this new value will be returned, otherwise the existing value will be

Specified by:: ensureAndGet in interface Map<K,V>

Parameters:: key - the key; putIfNotPresent - the put if not present
Returns:: the value associated with the provided key post method

ensureAndGet

public V ensureAndGet(K key,
                      Function<? super K,? extends V> putIfNotPresent)

Description copied from interface: Map

Equivalent to putIfAbsent(key, putIfNotPresent.create(key)), except that

putIfNotPresent.create() is only executed if there is no key associated with the value. In concurrent maps this is not a guarantee, but a best effort, as it is possible for another thread to set a value for the key after this has executed but before the record can be inserted
instead of returning the value previously associated with the key, returns the value associated with the key as the method is exiting; i.e. if a new value is associated with the key as a result of this method, this new value will be returned, otherwise the existing value will be

Specified by:: ensureAndGet in interface Map<K,V>

Parameters:: key - the key; putIfNotPresent - put if not present
Returns:: the value associated with the key post method

entries

public Set<java.util.Map.Entry<K,V>> entries()

Description copied from interface: AnyReadMap

Returns a set representing all the key->value pairs in this map. In a ListMap this will be a MultiSet. This set should always reflect changes to the map, and changes to the set should be reflected in the map also. Otherwise, this set should behave exactly as a regular set does.

Specified by:: entries in interface AnyMap<K,V>
Specified by:: entries in interface AnyReadMap<K,V>
Specified by:: entries in interface Map<K,V>

Returns:: the entry set< k>

entries

public java.lang.Iterable<java.util.Map.Entry<K,V>> entries(K key)

Description copied from interface: AnyReadMap

Returns an Iterable over all key->value maplets in the map whose key is equal to the one provided, as determined by the map's definition of equality.

Specified by:: entries in interface AnyReadMap<K,V>

Parameters:: key - find
Returns:: maplets with the provided key

get

public V get(K key)

Description copied from interface: Map

A convenience method, equivalent to first(key)

Specified by:: get in interface Map<K,V>

Parameters:: key - the key
Returns:: the value associated with the key, or null if none

inverse

public AnyMap<V,K> inverse()

Description copied from interface: AnyMap

Returns a map representing the inverse function of this map. This operation will typically be expensive unless the map is a BiMap in which case the action is trivial. The method may not return a map of the same type as the one it is called on (although typically this will be the case, and should happen wherever possible).

Specified by:: inverse in interface AnyMap<K,V>

Returns:: the inverse map/function of the one called upon

isEmpty

public boolean isEmpty()

Description copied from interface: AnyReadMap

Returns true iff the map is empty

Specified by:: isEmpty in interface AnyReadMap<K,V>

Returns:: true, if empty

keys

public Set<K> keys()

Description copied from interface: AnyReadMap

Returns a set representing all the keys in the domain of this map. In a MultiMap or ListMap this will be a MultiSet. This set should always reflect changes to the map, and changes to the set should be reflected in the map also. Otherwise, this set should behave exactly as a regular set does. The key equality used by this map can be obtained from this set.

Depending on the implementation of map, this key set may contain every occurrence of equal keys provided to the map, or may contain a subset thereof with repetitions to bring the number of occurrences in line with the number provided.

Note that the put() methods on this set will always fail, because no value can be provided to update the map with.

Specified by:: keys in interface AnyMap<K,V>
Specified by:: keys in interface AnyReadMap<K,V>
Specified by:: keys in interface Map<K,V>

Returns:: the key set< k>

list

public java.util.List<V> list(K key)

Description copied from interface: AnyReadMap

Returns a List of all values in the map which are mapped to by the provided key, as determined by the map's definition of equality. This list should be constructed "eagerly" and should be a consistent snapshot of the values valid at some point between the method being called and it returning.

Specified by:: list in interface AnyReadMap<K,V>

Parameters:: key - the key
Returns:: the list< v>

permitsDuplicateKeys

public boolean permitsDuplicateKeys()

Description copied from interface: AnyReadMap

Returns true if a key can map to more than one value

Specified by:: permitsDuplicateKeys in interface AnyReadMap<K,V>

Returns:: true, if keys can map to more than one value

add

public boolean add(K key,
                   V val)

Description copied from interface: AnyMap

Attempt to add the pair to the map, returning false if it could not be added, and true otherwise. In a ListMap the return value will always be true; however in a MultiMap it will be false, and hence the map remain unmodified, if a pair whose key and value are both equal to the ones provided (as determined by the map's definitions of equality) is already present; and in a Map it will be false if a pair whose key is equal to the one provided is already present. When the value of the pair is inequal to null, this is equivalent to put(key, value) == null

Specified by:: add in interface AnyMap<K,V>

Parameters:: key - key to insert; val - value to insert
Returns:: true if the map was modified, false otherwise

put

public V put(K key,
             V val)

Description copied from interface: Map

Ensures that the provided key binds to the provided value, removing and returning the value currently associated with the key, or null if none.

Specified by:: put in interface AnyMap<K,V>
Specified by:: put in interface Map<K,V>

Parameters:: key - the key; val - the val
Returns:: the value of any maplet removed as a result of this action

putIfAbsent

public V putIfAbsent(K key,
                     Function<? super K,? extends V> putIfNotPresent)

Description copied from interface: Map

Equivalent to putIfAbsent(key, putIfNotPresent.create()), except that putIfNotPresent.create() is only executed if there is no key associated with the value. In concurrent maps this is not a guarantee, but a best effort, as it is possible for another thread to set a value for the key after this has executed but before the record can be inserted.

Specified by:: putIfAbsent in interface Map<K,V>

Parameters:: key - the key; putIfNotPresent - the put if not present
Returns:: the value associated with the provided key pre method

putIfAbsent

public V putIfAbsent(K key,
                     V val)

Description copied from interface: Map

Attempts to bind the provided key to the provided value. If the key does not occur in the map then the value will be associated with it and null returned. If the key occurs in the map and is bound to a different value then this existing value will be returned

Specified by:: putIfAbsent in interface AnyMap<K,V>
Specified by:: putIfAbsent in interface Map<K,V>

Parameters:: key - the key; val - the val
Returns:: the value already associated with the key in the map, or null if none

remove

public int remove(K key,
                  V val)

Description copied from interface: AnyMap

Removes all occurrences of the provided key->value pair from the map, returning an integer representing the total number of items removed

Specified by:: remove in interface AnyMap<K,V>

Parameters:: key - the key; val - the val
Returns:: the number removed

remove

public int remove(K key)

Description copied from interface: AnyMap

Removes all occurrences of the provided key from domain of the map, returning an integer representing the total number of items removed

Specified by:: remove in interface AnyMap<K,V>

Parameters:: key - remove
Returns:: the number removed

removeAndReturn

public java.lang.Iterable<java.util.Map.Entry<K,V>> removeAndReturn(K key,
                                                                    V val)

Description copied from interface: AnyMap

Removes all occurrences of the provided key->value pair from the map, returning the entries removed

Specified by:: removeAndReturn in interface AnyMap<K,V>

Parameters:: key - key to remove; val - value to remove
Returns:: entries removed

removeAndReturn

public java.lang.Iterable<java.util.Map.Entry<K,V>> removeAndReturn(K key)

Description copied from interface: AnyMap

Removes all occurrences of the provided key from domain of the map, returning the entries removed

Specified by:: removeAndReturn in interface AnyMap<K,V>

Parameters:: key - key to remove
Returns:: entries removed

removeAndReturnFirst

public V removeAndReturnFirst(K key)

Description copied from interface: AnyMap

Removes all occurrences of the provided key from domain of the map, returning the first such value removed, or null if none

Specified by:: removeAndReturnFirst in interface AnyMap<K,V>

Parameters:: key - the key to remove
Returns:: the value associated with the first key removed, or null if none

shrink

public void shrink()

Description copied from interface: AnyMap

Attempts to make the map use less memory, if possible.

Specified by:: shrink in interface AnyMap<K,V>

size

public int size()

Description copied from interface: Map

A convenience method, equivalent to both totalCount() and uniqueKeyCount()

Specified by:: size in interface Map<K,V>

Returns:: the int

totalCount

public int totalCount()

Description copied from interface: AnyReadMap

Return an integer representing the total number of maplets (i.e. counting all occurrences of each key) in the map

Specified by:: totalCount in interface AnyReadMap<K,V>

Returns:: the total number of maplets

uniqueKeyCount

public int uniqueKeyCount()

Description copied from interface: AnyReadMap

Return an integer representing the number of unique keys in the domain of the map

Specified by:: uniqueKeyCount in interface AnyReadMap<K,V>

Returns:: number of unique keys

values

public AnySet<V> values()

Description copied from interface: AnyMap

Returns a set representing the range of the map. Operations on this set will typically be expensive (O(n) where n is the size of the map).

Specified by:: values in interface AnyMap<K,V>
Specified by:: values in interface AnyReadMap<K,V>

Returns:: the range of the map

values

public UnitarySet<V> values(K key)

Description copied from interface: AnyReadMap

Returns a set representing the values associated with the provided key in this map. This set should always reflect changes to the map, and changes to the set should be reflected in the map also. Otherwise, this set should behave exactly as a regular set does.

Note that in a regular (scalar) map the set returned will be a UnitarySet, which contains at most one value. put() operations on such a set will override any existing value regardless of if it is equal to the one already present.

Specified by:: values in interface AnyMap<K,V>
Specified by:: values in interface AnyReadMap<K,V>
Specified by:: values in interface Map<K,V>

Returns:: the set of values mapped to by provided key

first

public V first(K key)

Description copied from interface: AnyReadMap

Returns the value associated with the first key that is equal to the one provided, as determined by the map's definition of equality. Returns null if no matching key is found.

Specified by:: first in interface AnyReadMap<K,V>

Parameters:: key - the key
Returns:: the value associated with the first matching key

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jjoost.collections.maps.wrappers Class DefaultFunctionMap<K,V>

DefaultFunctionMap

apply

clear

clearAndReturn

contains

contains

copy

count

count

ensureAndGet

ensureAndGet

entries

entries

get

inverse

isEmpty

keys

list

permitsDuplicateKeys

add

put

putIfAbsent

putIfAbsent

remove

remove

removeAndReturn

removeAndReturn

removeAndReturnFirst

shrink

size

totalCount

uniqueKeyCount

values

values

first

org.jjoost.collections.maps.wrappers
Class DefaultFunctionMap<K,V>