javadoc.com.google.common.collect.MapConstraints.html Maven / Gradle / Ivy
MapConstraints (Guava: Google Core Libraries for Java 11.0.1 API)
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD
com.google.common.collect
Class MapConstraints
java.lang.Object
com.google.common.collect.MapConstraints
@Beta
@GwtCompatible
public final class MapConstraints
- extends Object
Factory and utilities pertaining to the MapConstraint
interface.
- Since:
- 3.0
- Author:
- Mike Bostock
- See Also:
Constraints
Method Summary | ||
---|---|---|
static
|
constrainedBiMap(BiMap<K,V> map,
MapConstraint<? super K,? super V> constraint)
Returns a constrained view of the specified bimap, using the specified constraint. |
|
static
|
constrainedListMultimap(ListMultimap<K,V> multimap,
MapConstraint<? super K,? super V> constraint)
Returns a constrained view of the specified list multimap, using the specified constraint. |
|
static
|
constrainedMap(Map<K,V> map,
MapConstraint<? super K,? super V> constraint)
Returns a constrained view of the specified map, using the specified constraint. |
|
static
|
constrainedMultimap(Multimap<K,V> multimap,
MapConstraint<? super K,? super V> constraint)
Returns a constrained view of the specified multimap, using the specified constraint. |
|
static
|
constrainedSetMultimap(SetMultimap<K,V> multimap,
MapConstraint<? super K,? super V> constraint)
Returns a constrained view of the specified set multimap, using the specified constraint. |
|
static
|
constrainedSortedSetMultimap(SortedSetMultimap<K,V> multimap,
MapConstraint<? super K,? super V> constraint)
Returns a constrained view of the specified sorted-set multimap, using the specified constraint. |
|
static MapConstraint<Object,Object> |
notNull()
Returns a constraint that verifies that neither the key nor the value is null. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
notNull
public static MapConstraint<Object,Object> notNull()
- Returns a constraint that verifies that neither the key nor the value is
null. If either is null, a
NullPointerException
is thrown.
constrainedMap
public static <K,V> Map<K,V> constrainedMap(Map<K,V> map, MapConstraint<? super K,? super V> constraint)
- Returns a constrained view of the specified map, using the specified
constraint. Any operations that add new mappings will call the provided
constraint. However, this method does not verify that existing mappings
satisfy the constraint.
The returned map is not serializable.
- Parameters:
map
- the map to constrainconstraint
- the constraint that validates added entries- Returns:
- a constrained view of the specified map
constrainedMultimap
public static <K,V> Multimap<K,V> constrainedMultimap(Multimap<K,V> multimap, MapConstraint<? super K,? super V> constraint)
- Returns a constrained view of the specified multimap, using the specified
constraint. Any operations that add new mappings will call the provided
constraint. However, this method does not verify that existing mappings
satisfy the constraint.
Note that the generated multimap's
Multimap.removeAll(java.lang.Object)
andMultimap.replaceValues(K, java.lang.Iterable extends V>)
methods return collections that are not constrained.The returned multimap is not serializable.
- Parameters:
multimap
- the multimap to constrainconstraint
- the constraint that validates added entries- Returns:
- a constrained view of the multimap
constrainedListMultimap
public static <K,V> ListMultimap<K,V> constrainedListMultimap(ListMultimap<K,V> multimap, MapConstraint<? super K,? super V> constraint)
- Returns a constrained view of the specified list multimap, using the
specified constraint. Any operations that add new mappings will call the
provided constraint. However, this method does not verify that existing
mappings satisfy the constraint.
Note that the generated multimap's
Multimap.removeAll(java.lang.Object)
andMultimap.replaceValues(K, java.lang.Iterable extends V>)
methods return collections that are not constrained.The returned multimap is not serializable.
- Parameters:
multimap
- the multimap to constrainconstraint
- the constraint that validates added entries- Returns:
- a constrained view of the specified multimap
constrainedSetMultimap
public static <K,V> SetMultimap<K,V> constrainedSetMultimap(SetMultimap<K,V> multimap, MapConstraint<? super K,? super V> constraint)
- Returns a constrained view of the specified set multimap, using the
specified constraint. Any operations that add new mappings will call the
provided constraint. However, this method does not verify that existing
mappings satisfy the constraint.
Note that the generated multimap's
Multimap.removeAll(java.lang.Object)
andMultimap.replaceValues(K, java.lang.Iterable extends V>)
methods return collections that are not constrained.The returned multimap is not serializable.
- Parameters:
multimap
- the multimap to constrainconstraint
- the constraint that validates added entries- Returns:
- a constrained view of the specified multimap
constrainedSortedSetMultimap
public static <K,V> SortedSetMultimap<K,V> constrainedSortedSetMultimap(SortedSetMultimap<K,V> multimap, MapConstraint<? super K,? super V> constraint)
- Returns a constrained view of the specified sorted-set multimap, using the
specified constraint. Any operations that add new mappings will call the
provided constraint. However, this method does not verify that existing
mappings satisfy the constraint.
Note that the generated multimap's
Multimap.removeAll(java.lang.Object)
andMultimap.replaceValues(K, java.lang.Iterable extends V>)
methods return collections that are not constrained.The returned multimap is not serializable.
- Parameters:
multimap
- the multimap to constrainconstraint
- the constraint that validates added entries- Returns:
- a constrained view of the specified multimap
constrainedBiMap
public static <K,V> BiMap<K,V> constrainedBiMap(BiMap<K,V> map, MapConstraint<? super K,? super V> constraint)
- Returns a constrained view of the specified bimap, using the specified
constraint. Any operations that modify the bimap will have the associated
keys and values verified with the constraint.
The returned bimap is not serializable.
- Parameters:
map
- the bimap to constrainconstraint
- the constraint that validates added entries- Returns:
- a constrained view of the specified bimap
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010-2012. All Rights Reserved.