root
API
Generated with
root/play/play.api/play.api.libs/play.api.libs.typedmap/TypedKey

TypedKey

play.api.libs.typedmap.TypedKey
See theTypedKey companion object
final class TypedKey[A]

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.

Type parameters

A

The type of values associated with this key.

Value parameters

displayName

The name to display for this key or null if no display name has been provided. This name is only used for debugging. Keys with the same name are not considered to be equal.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def ->(value: A): TypedEntry[A]

Bind this key to a value. Equivalent to bindValue.

Bind this key to a value. Equivalent to bindValue.

Value parameters

value

The value to bind.

Attributes

Returns

An entry binding this key to a value of the right type.

def asJava: TypedKey[A]

Attributes

Returns

The Java version for this key.

def bindValue(value: A): TypedEntry[A]

Bind this key to a value. This is equivalent to the -> operator.

Bind this key to a value. This is equivalent to the -> operator.

Value parameters

value

The value to bind this key to.

Attributes

Returns

A bound value.

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any

Concrete fields

Generated with