org.lenskit.util

Class IdBox<T>

java.lang.Object

org.lenskit.util.IdBox<T>

All Implemented Interfaces:

KeyedObject

@Immutable
public final class IdBox<T>
extends java.lang.Object
implements KeyedObject

A box that associates an object with an ID.

Constructor Summary

Constructors

Constructor and Description
IdBox(long k, T o) Construct a new ID box.

Method Summary

Modifier and Type	Method and Description
static <T> IdBox<T>	create(long id, T obj) Construct a new ID box.
boolean	equals(java.lang.Object o)
long	getId() Get the ID associated with the object.
long	getKey() Get the key for this object.
T	getValue() Get the value associated with the object.
int	hashCode()
<R> IdBox<R>	mapValue(java.util.function.Function<? super T,? extends R> function) Transform the value in a box.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IdBox

public IdBox(long k,
             T o)

Construct a new ID box.

Parameters:

k - The ID.

o - The object.

Method Detail

create

public static <T> IdBox<T> create(long id,
                                  T obj)

Construct a new ID box.

Parameters:

id - The ID.

obj - The object.

T - The object type.

Returns:

An ID box associating obj with id.

getId

public long getId()

Get the ID associated with the object.

Returns:

The ID.

getKey

public long getKey()

Description copied from interface: KeyedObject

Get the key for this object.

Specified by:

getKey in interface KeyedObject

Returns:

A key identifying this object.

getValue

public T getValue()

Get the value associated with the object.

Returns:

The value.

mapValue

public <R> IdBox<R> mapValue(java.util.function.Function<? super T,? extends R> function)

Transform the value in a box.

Parameters:

function - The function to apply.

R - The function return type.

Returns:

An ID box with the same ID but whose value is the result of applying the function to this box’s value.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object