oracle.javatools.util

Enum Maps.CacheMap.Canonicity

java.lang.Object

java.lang.Enum<Maps.CacheMap.Canonicity>

oracle.javatools.util.Maps.CacheMap.Canonicity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Maps.CacheMap.Canonicity>

Enclosing class:

Maps.CacheMap<K,V>

public static enum Maps.CacheMap.Canonicity
extends java.lang.Enum<Maps.CacheMap.Canonicity>

The canonicity of a mapping. A canonical mapping guarantees to always map a given key to the same value; a non-canonical mapping does not.

In practice, this means that a cache implementing a canonical mapping cannot simply remove an entry to evict it, but must convert it to a weak reference to ensure it is retained as long as the value is referenced from outside the cache.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANONICAL
NOT_CANONICAL

Method Summary

Modifier and Type	Method and Description
static Maps.CacheMap.Canonicity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Maps.CacheMap.Canonicity[]	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

CANONICAL

public static final Maps.CacheMap.Canonicity CANONICAL

NOT_CANONICAL

public static final Maps.CacheMap.Canonicity NOT_CANONICAL

Method Detail

values

public static Maps.CacheMap.Canonicity[] 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 (Maps.CacheMap.Canonicity c : Maps.CacheMap.Canonicity.values())
    System.out.println(c);

Returns:

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

valueOf

public static Maps.CacheMap.Canonicity valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null