|
Groovy JDK |
Method Summary | |
---|---|
boolean
|
any(Closure closure)
Iterates over the entries of a map, and checks whether a predicate is valid for at least one entry |
Map
|
asImmutable()
A convenience method for creating an immutable map |
Map
|
asSynchronized()
A convenience method for creating a synchronized Map |
Object
|
asType(Class clazz)
Coerces this map to the given type, using the map's keys as the public method names, and values as the implementation would be a closure which behaves like the method implementation |
Collection
|
collect(Collection collection, Closure closure)
Iterates through this Map transforming each entry into a new value using the closure as a transformer, returning a list of transformed values |
List
|
collect(Closure closure)
Iterates through this Map transforming each entry into a new value using the closure as a transformer, returning a list of transformed values |
Map
|
each(Closure closure)
Allows a Map to be iterated through using a closure closure takes one parameter then it will be passed the Map otherwise if the closure takes two parameters then it will be passed the key and the value |
Object
|
eachWithIndex(Closure closure)
Allows a Map to be iterated through using a closure closure takes two parameters then it will be passed the Map the item's index (a counter starting at zero) otherwise if the closure takes three parameters then it will be passed the key, the value, and the index |
boolean
|
every(Closure closure)
Iterates over the entries of a map, and checks whether a predicate is valid for all entries |
Object
|
find(Closure closure)
Finds the first entry matching the closure condition two parameters, the entry key and value are passed one parameter, the Map |
Map
|
findAll(Closure closure)
Finds all entries matching the closure condition closure takes one parameter then it will be passed the Map Otherwise if the closure should take two parameters, which will be the key and the value |
Object
|
get(Object key, Object defaultValue)
Looks up an item in a Map for the given key and returns the value - unless there is no entry for the given key in which case add the default value to the map and return that |
Object
|
getAt(Object key)
Support the subscript operator for a Map |
Map
|
groupBy(Closure closure)
Groups the members of a map into sub maps determined by the supplied mapping closure key and value (depending on the number of parameters the closure accepts) and should return the key that each item should be grouped under resulting map will have an entry for each 'group' key returned by the closure, with values being the map members from the original map that belong to each group |
Map
|
groupEntriesBy(Closure closure)
Groups all map entries into groups determined by the supplied mapping closure key and value (depending on the number of parameters the closure accepts) and should return the key that each item should be grouped under resulting map will have an entry for each 'group' key returned by the closure, with values being the list of map entries that belong to each group |
Map
|
plus(Map right)
Returns a new Map containing all entries from left and right ,
giving precedence to right
will appear in the resultant map with values from the right
operand
or Properties, the returned Map will preserve that type, otherwise a HashMap will
be returned
Roughly equivalent to Map m = new HashMap(); m
but with some additional logic to preserve the |
Object
|
putAt(Object key, Object value)
A helper method to allow lists to work with subscript operators |
SpreadMap
|
spread()
Synonym for {@link #toSpreadMap(Map)} |
Map
|
subMap(Collection keys)
Creates a sub-Map containing the given keys List |
String
|
toMapString()
Returns the string representation of this map contents of the map, i |
SpreadMap
|
toSpreadMap()
Returns a new SpreadMap from this map
For examples, if there is defined a function like as
, then all of the following three have the same meaningdef fn(a, b, c, d) { return a + b + c + d } println fn(a:1, [b:2, c:3] println fn(a:1, *:[b:2, c:3], d:4) println fn(a:1, b:2, c:3, d:4) |
String
|
toString()
Returns the string representation of the given map |
Method Detail |
---|
public boolean any(Closure closure)
closure
- the closure predicate used for matching.
public Map asImmutable()
public Map asSynchronized()
public Object asType(Class clazz)
clazz
- the target type.
public Collection collect(Collection collection, Closure closure)
collection
- the Collection to which the mapped values are added.
closure
- the closure used for mapping, which can take one (Map.Entry) or two (key, value) parameters.
public List collect(Closure closure)
closure
- the closure used to map each element of the collection.
public Map each(Closure closure)
closure
- the closure applied on each entry of the map.
public Object eachWithIndex(Closure closure)
closure
- a Closure to operate on each item.
public boolean every(Closure closure)
closure
- the closure predicate used for matching.
public Object find(Closure closure)
closure
- a closure condition.
public Map findAll(Closure closure)
closure
- a closure condition applying on the entries.
public Object get(Object key, Object defaultValue)
key
- the key to lookup the value of.
defaultValue
there
- the value to return and add to the map for this key if
there is no entry for the given key.
public Object getAt(Object key)
key
- an Object as a key for the map.
public Map groupBy(Closure closure)
closure
- a closure mapping entries on keys.
public Map groupEntriesBy(Closure closure)
closure
- a closure mapping entries on keys.
public Map plus(Map right)
left
and right
,
giving precedence to right
. Any keys appearing in both Maps
will appear in the resultant map with values from the right
operand. If the left
map is one of TreeMap, LinkedHashMap, Hashtable
or Properties, the returned Map will preserve that type, otherwise a HashMap will
be returned.
Roughly equivalent to Map m = new HashMap(); m.putAll(left); m.putAll(right); return m;
but with some additional logic to preserve the left
Map type for common cases as
described above.
right
- a Map.
public Object putAt(Object key, Object value)
key
- an Object as a key for the map.
value
- the value to put into the map.
public SpreadMap spread()
public Map subMap(Collection keys)
keys
- a Collection of keys.
public String toMapString()
{one=1, two=2, three=3}
.
public SpreadMap toSpreadMap()
SpreadMap
from this map.
For examples, if there is defined a function like as
, then all of the following three have the same meaning.def fn(a, b, c, d) { return a + b + c + d }
println fn(a:1, [b:2, c:3].toSpreadMap(), d:4) println fn(a:1, *:[b:2, c:3], d:4) println fn(a:1, b:2, c:3, d:4)
public String toString()
|
Groovy JDK |