Packages

trait EntityTypeKey[T] extends AnyRef

The key of an entity type, the name must be unique.

Not for user extension.

Annotations
@DoNotInherit()
Source
ClusterSharding.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EntityTypeKey
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def name: String

    Name of the entity type.

  2. abstract def persistenceIdFrom(entityId: String): PersistenceId

    Constructs a PersistenceId from this EntityTypeKey and the given entityId by concatenating them with | separator.

    Constructs a PersistenceId from this EntityTypeKey and the given entityId by concatenating them with | separator.

    The | separator is also used in Lagom's scaladsl.PersistentEntity but no separator is used in Lagom's javadsl.PersistentEntity. For compatibility with Lagom's javadsl.PersistentEntity you should use "" as the separator in EntityTypeKey.withEntityIdSeparator.

  3. abstract def withEntityIdSeparator(separator: String): EntityTypeKey[T]

    Specify a custom separator for compatibility with old naming conventions.

    Specify a custom separator for compatibility with old naming conventions. The separator is used between the EntityTypeKey and the entityId when constructing a persistenceId with EntityTypeKey.persistenceIdFrom.

    The default | separator is also used in Lagom's scaladsl.PersistentEntity but no separator is used in Lagom's javadsl.PersistentEntity. For compatibility with Lagom's javadsl.PersistentEntity you should use "" as the separator here.