net.tridentsdk.util

Class Pair<K,V>

java.lang.Object

net.tridentsdk.util.Pair<K,V>

public abstract class Pair<K,V>
extends Object

A pair of objects

This class has no constructor. Rather, it has several different factory methods that instantiate internal implementations of the Pair. For most intents and purposes, one would use the mutable[XXX]() factory methods, depending on the context of usage.

Author:

The TridentSDK Team

Method Summary

Modifier and Type	Method and Description
static <K,V> Pair<K,V>	immutable(K key, V value) Creates a new immutable pair with the given arguments
boolean	isImmutable() Checks this pair in order to ensure whether it is immutable or not
abstract K	key() Obtains the key in this pair
static <K,V> Pair<K,V>	mutable() Creates a new mutable pair
static <K,V> Pair<K,V>	mutable(K key, V value) Creates a new mutable pair with the given start arguments
void	read(java.util.function.BiConsumer<K,V> consumer) Processes the pair
<T> T	read(java.util.function.BiFunction<K,V,T> func) Reads both key and value and returns a result
void	set(K key, V val) Sets both the key and values of this pair
abstract void	setKey(K key) Sets the key of this pair
abstract void	setVal(V val) Sets the value of this pair
static <K,V> Pair<K,V>	threadSafe() Creates a new thread safe pair
static <K,V> Pair<K,V>	threadSafe(K key, V value) Creates a new thread safe pair with the given start arguments
void	transfer(Pair<K,V> pair) Copies the key and value of the current pair to another pair
abstract V	val() Obtains the value in this pair

Methods inherited from class java.lang.Object

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

Method Detail

mutable

public static <K,V> Pair<K,V> mutable()

Creates a new mutable pair

Type Parameters:

K - the key type

V - the value type

Returns:

the new mutable pair

mutable

public static <K,V> Pair<K,V> mutable(K key,
                                      V value)

Creates a new mutable pair with the given start arguments

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key initial value

value - the value initial value

Returns:

the new mutable pair

threadSafe

public static <K,V> Pair<K,V> threadSafe()

Creates a new thread safe pair

Type Parameters:

K - the key type

V - the value type

Returns:

the new thread safe pair

threadSafe

public static <K,V> Pair<K,V> threadSafe(K key,
                                         V value)

Creates a new thread safe pair with the given start arguments

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key initial value

value - the value initial value

Returns:

the new thread safe pair

immutable

public static <K,V> Pair<K,V> immutable(K key,
                                        V value)

Creates a new immutable pair with the given arguments

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key value

value - the value value

Returns:

the new immutable pair

key

public abstract K key()

Obtains the key in this pair

Returns:

the key

val

public abstract V val()

Obtains the value in this pair

Returns:

the value

read

public void read(java.util.function.BiConsumer<K,V> consumer)

Processes the pair

Parameters:

consumer - the key-value reader

read

public <T> T read(java.util.function.BiFunction<K,V,T> func)

Reads both key and value and returns a result

Type Parameters:

T - the type to be returned

Parameters:

func - the reader

Returns:

the function's result

transfer

public void transfer(Pair<K,V> pair)

Copies the key and value of the current pair to another pair

Parameters:

pair - the pair to transfer to

Throws:

UnsupportedOperationException - if the given pair is immutable

setKey

public abstract void setKey(K key)

Sets the key of this pair

Parameters:

key - the key to set

Throws:

UnsupportedOperationException - if the pair is immutable

setVal

public abstract void setVal(V val)

Sets the value of this pair

Parameters:

val - the value to set

Throws:

UnsupportedOperationException - if the pair is immutable

set

public void set(K key,
                V val)

Sets both the key and values of this pair

Parameters:

key - the key to set

val - the value to set

Throws:

UnsupportedOperationException - if the pair is immutable

isImmutable

public boolean isImmutable()

Checks this pair in order to ensure whether it is immutable or not

Returns:

true if the pair is immutable, false if not