org.lenskit.data.entities

Class TypedName<T>

java.lang.Object

org.lenskit.data.entities.TypedName<T>

All Implemented Interfaces:

java.io.Serializable

@Immutable
public final class TypedName<T>
extends java.lang.Object
implements java.io.Serializable

An association of a type with a name. This is used for type-safe (or at least type-suggested) access to entity attributes, and allows declarations of attribute names to also contain the type of data that will be stored in the specified attribute.

When used consistently, they allow for type-safe access to entity attribute data.

Typed names are unique objects, so they can be safely compared with ==.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static <T> TypedName<T>	create(java.lang.String name, java.lang.Class<T> type) Create a typed name object.
static TypedName<?>	create(java.lang.String name, java.lang.String typeName) Create an typed name from a name and type name.
static <T> TypedName<T>	create(java.lang.String name, TypeToken<T> type) Create a typed name object.
com.fasterxml.jackson.databind.JavaType	getJacksonType() Get a Jackson JavaType for this typed name.
java.lang.String	getName() Get the underlying name.
java.lang.Class<? super T>	getRawType() Get the raw type (class).
TypeToken<T>	getType() Get the type.
T	parseString(java.lang.String value) Parse a string containing this attribute’s value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

@Nonnull
public java.lang.String getName()

Get the underlying name.

Returns:

The name. This is guaranteed to be an interned string (see String.intern()).

getType

@Nonnull
public TypeToken<T> getType()

Get the type. This will never be a primitive type class; primitive classes are always normalized to their wrapper classes (e.g. long.class becomes Long.class).

Returns:

The type.

getRawType

@Nonnull
public java.lang.Class<? super T> getRawType()

Get the raw type (class). This will never be a primitive type class; primitive classes are always normalized to their wrapper classes (e.g. long.class becomes Long.class).

Returns:

The type.

getJacksonType

public com.fasterxml.jackson.databind.JavaType getJacksonType()

Get a Jackson JavaType for this typed name.

Returns:

The Jackson java type.

parseString

public T parseString(java.lang.String value)

Parse a string containing this attribute’s value.

Returns:

The attribute value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

create

@Nonnull
public static <T> TypedName<T> create(java.lang.String name,
                                               java.lang.Class<T> type)

Create a typed name object.

Parameters:

name - The name.

type - The type.

Returns:

An object encapsulating the specified name and type.

create

@Nonnull
public static <T> TypedName<T> create(java.lang.String name,
                                               TypeToken<T> type)

Create a typed name object.

Parameters:

name - The name.

type - The type.

Returns:

An object encapsulating the specified name and type.

create

public static TypedName<?> create(java.lang.String name,
                                  java.lang.String typeName)

Create an typed name from a name and type name.

Parameters:

name - The name.

typeName - The type name.

Returns:

The attribute.

Throws:

java.lang.IllegalArgumentException - if typeName is not a valid type name.