org.datavec.api.util

Class MultiDimensionalMap.Entry<K,T,V>

java.lang.Object

org.datavec.api.util.MultiDimensionalMap.Entry<K,T,V>

All Implemented Interfaces:

java.util.Map.Entry<Pair<K,T>,V>

Enclosing class:

MultiDimensionalMap<K,T,V>

public static class MultiDimensionalMap.Entry<K,T,V>
extends java.lang.Object
implements java.util.Map.Entry<Pair<K,T>,V>

Constructor Summary

Constructors

Constructor and Description
Entry(K firstKey, T secondKey, V value)

Method Summary

Modifier and Type	Method and Description
K	getFirstKey()
Pair<K,T>	getKey() Returns the key corresponding to this entry.
T	getSecondKey()
V	getValue()
void	setFirstKey(K firstKey)
void	setSecondKey(T secondKey)
V	setValue(V value) Replaces the value corresponding to this entry with the specified value (optional operation).

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue, equals, hashCode

Constructor Detail

Entry

public Entry(K firstKey,
             T secondKey,
             V value)

Method Detail

getFirstKey

public K getFirstKey()

setFirstKey

public void setFirstKey(K firstKey)

getSecondKey

public T getSecondKey()

setSecondKey

public void setSecondKey(T secondKey)

getValue

public V getValue()

Specified by:

getValue in interface java.util.Map.Entry<Pair<K,T>,V>

setValue

public V setValue(V value)

Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove operation).

Specified by:

setValue in interface java.util.Map.Entry<Pair<K,T>,V>

Parameters:

value - new value to be stored in this entry

Returns:

old value corresponding to the entry

Throws:

java.lang.UnsupportedOperationException - if the put operation is not supported by the backing map

java.lang.ClassCastException - if the class of the specified value prevents it from being stored in the backing map

java.lang.NullPointerException - if the backing map does not permit null values, and the specified value is null

java.lang.IllegalArgumentException - if some property of this value prevents it from being stored in the backing map

java.lang.IllegalStateException - implementations may, but are not required to, throw this exception if the entry has been removed from the backing map.

getKey

public Pair<K,T> getKey()

Returns the key corresponding to this entry.

Specified by:

getKey in interface java.util.Map.Entry<Pair<K,T>,V>

Returns:

the key corresponding to this entry

Throws:

java.lang.IllegalStateException - implementations may, but are not required to, throw this exception if the entry has been removed from the backing map.