com.google.common.collect.testing.features
Enum MapFeature

java.lang.Object
  java.lang.Enum<MapFeature>
      com.google.common.collect.testing.features.MapFeature

All Implemented Interfaces:

Feature<Map>, Serializable, Comparable<MapFeature>

public enum MapFeature
extends Enum<MapFeature>
implements Feature<Map>

Optional features of classes derived from Map.

This class is GWT compatible.

Author:

George van den Driessche

Nested Class Summary

static interface

MapFeature.Require

Enum Constant Summary

ALLOWS_NULL_KEYS

ALLOWS_NULL_QUERIES
The map does not throw NullPointerException on calls such as containsKey(null), get(null), or remove(null).

ALLOWS_NULL_VALUES

GENERAL_PURPOSE

REJECTS_DUPLICATES_AT_CREATION
Indicates that the constructor or factory method of a map, usually an immutable map, throws an IllegalArgumentException when presented with duplicate keys instead of discarding all but one.

REMOVE_OPERATIONS
Features supported by maps where only removal is allowed.

RESTRICTS_KEYS

RESTRICTS_VALUES

SUPPORTS_CLEAR

SUPPORTS_PUT

SUPPORTS_PUT_ALL

SUPPORTS_REMOVE

Method Summary

Set<Feature<? super Map>>	getImpliedFeatures() Returns the set of features that are implied by this feature.
static MapFeature	valueOf(String name) Returns the enum constant of this type with the specified name.
static MapFeature[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALLOWS_NULL_QUERIES

public static final MapFeature ALLOWS_NULL_QUERIES

The map does not throw NullPointerException on calls such as containsKey(null), get(null), or remove(null).

ALLOWS_NULL_KEYS

public static final MapFeature ALLOWS_NULL_KEYS

ALLOWS_NULL_VALUES

public static final MapFeature ALLOWS_NULL_VALUES

RESTRICTS_KEYS

public static final MapFeature RESTRICTS_KEYS

RESTRICTS_VALUES

public static final MapFeature RESTRICTS_VALUES

SUPPORTS_PUT

public static final MapFeature SUPPORTS_PUT

SUPPORTS_PUT_ALL

public static final MapFeature SUPPORTS_PUT_ALL

SUPPORTS_REMOVE

public static final MapFeature SUPPORTS_REMOVE

SUPPORTS_CLEAR

public static final MapFeature SUPPORTS_CLEAR

REJECTS_DUPLICATES_AT_CREATION

public static final MapFeature REJECTS_DUPLICATES_AT_CREATION

Indicates that the constructor or factory method of a map, usually an immutable map, throws an IllegalArgumentException when presented with duplicate keys instead of discarding all but one.

GENERAL_PURPOSE

public static final MapFeature GENERAL_PURPOSE

REMOVE_OPERATIONS

public static final MapFeature REMOVE_OPERATIONS

Features supported by maps where only removal is allowed.

Method Detail

values

public static MapFeature[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MapFeature c : MapFeature.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MapFeature valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getImpliedFeatures

public Set<Feature<? super Map>> getImpliedFeatures()

Description copied from interface: Feature

Returns the set of features that are implied by this feature.

Specified by:

getImpliedFeatures in interface Feature<Map>