com.trivago.triava.tcache.util

Class KeyValueUtil<K,V>

java.lang.Object

com.trivago.triava.tcache.util.KeyValueUtil<K,V>

Type Parameters:

K - The key class

V - The value class

public class KeyValueUtil<K,V>
extends Object

Perform check operations on cache keys and values.

Implementation note: This class could be using static methods. But it was decided to use Generics to spot errors in parameter passing more easily, e.g. mixing up key and value.

Author:

cesken

Constructor Summary

Constructors

Constructor and Description
KeyValueUtil(String id) Creates a typed KeyValueUtil for the given Cache.

Method Summary

Modifier and Type	Method and Description
void	verifyKeyAndValueNotNull(K key, V value) Checks whether key or value are null.
void	verifyKeyNotNull(K key) Checks whether key is null.
void	verifyKeysNotNull(Set<? extends K> keys)
void	verifyValueNotNull(V value) Checks whether key is null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyValueUtil

public KeyValueUtil(String id)

Creates a typed KeyValueUtil for the given Cache.

Parameters:

id - The id (or cacheName) of the Cache

Method Detail

verifyKeyAndValueNotNull

public void verifyKeyAndValueNotNull(K key,
                                     V value)

Checks whether key or value are null. If at least one parameter is null, NullPointerException is thrown. Otherwise this method returns without any side-effects.

JSR107 mandates to throw NullPointerException. This is not in the Javadoc of JSR107, but in the general part of the specification document: "Any attempt to use null for keys or values will result in a NullPointerException being thrown, regardless of the use."

Parameters:

key - The key

value - The value

Throws:

NullPointerException - if at least one parameter is null

verifyKeyNotNull

public void verifyKeyNotNull(K key)

Checks whether key is null. If it is null, NullPointerException is thrown. Otherwise this method returns without any side-effects.

JSR107 mandates to throw NullPointerException. This is not in the Javadoc of JSR107, but in the general part of the specification document: "Any attempt to use null for keys or values will result in a NullPointerException being thrown, regardless of the use."

Parameters:

key - The key

Throws:

NullPointerException - if key is null

verifyValueNotNull

public void verifyValueNotNull(V value)

Checks whether key is null. If it is null, NullPointerException is thrown. Otherwise this method returns without any side-effects.

JSR107 mandates to throw NullPointerException. This is not in the Javadoc of JSR107, but in the general part of the specification document: "Any attempt to use null for keys or values will result in a NullPointerException being thrown, regardless of the use."

Parameters:

value - The value

Throws:

NullPointerException - if value is null

verifyKeysNotNull

public void verifyKeysNotNull(Set<? extends K> keys)