play.libs.typedmap

Class TypedKey<A>

java.lang.Object

play.libs.typedmap.TypedKey<A>

public final class TypedKey<A>
extends java.lang.Object

A TypedKey is a key that can be used to get and set values in a TypedMap or any object with typed keys. This class uses reference equality for comparisons, so each new instance is different key.

Constructor Summary

Constructors

Constructor and Description
TypedKey(play.api.libs.typedmap.TypedKey<A> underlying)

Method Summary

Modifier and Type	Method and Description
play.api.libs.typedmap.TypedKey<A>	asScala()
TypedEntry<A>	bindValue(A value) Bind this key to a value.
static <A> TypedKey<A>	create() Creates a TypedKey without a name.
static <A> TypedKey<A>	create(java.lang.String displayName) Creates a TypedKey with the given name.
boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String	toString()
play.api.libs.typedmap.TypedKey<A>	underlying() Deprecated. As of release 2.6.8. Use asScala()

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedKey

public TypedKey(play.api.libs.typedmap.TypedKey<A> underlying)

Method Detail

underlying

@Deprecated
public play.api.libs.typedmap.TypedKey<A> underlying()

Deprecated. As of release 2.6.8. Use asScala()

Returns:

the underlying Scala TypedKey which this instance wraps.

asScala

public play.api.libs.typedmap.TypedKey<A> asScala()

Returns:

the underlying Scala TypedKey which this instance wraps.

bindValue

public TypedEntry<A> bindValue(A value)

Bind this key to a value.

Parameters:

value - The value to bind this key to.

Returns:

A bound value.

create

public static <A> TypedKey<A> create()

Creates a TypedKey without a name.

Type Parameters:

A - The type of value this key is associated with.

Returns:

A fresh key.

create

public static <A> TypedKey<A> create(java.lang.String displayName)

Creates a TypedKey with the given name.

Type Parameters:

A - The type of value this key is associated with.

Parameters:

displayName - The name to display when printing this key.

Returns:

A fresh key.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object