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
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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EntityTypeKey[T] to any2stringadd[EntityTypeKey[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EntityTypeKey[T], B)
    Implicit
    This member is added by an implicit conversion from EntityTypeKey[T] to ArrowAssoc[EntityTypeKey[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  8. def ensuring(cond: (EntityTypeKey[T]) ⇒ Boolean, msg: ⇒ Any): EntityTypeKey[T]
    Implicit
    This member is added by an implicit conversion from EntityTypeKey[T] to Ensuring[EntityTypeKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (EntityTypeKey[T]) ⇒ Boolean): EntityTypeKey[T]
    Implicit
    This member is added by an implicit conversion from EntityTypeKey[T] to Ensuring[EntityTypeKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): EntityTypeKey[T]
    Implicit
    This member is added by an implicit conversion from EntityTypeKey[T] to Ensuring[EntityTypeKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): EntityTypeKey[T]
    Implicit
    This member is added by an implicit conversion from EntityTypeKey[T] to Ensuring[EntityTypeKey[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EntityTypeKey[T] to StringFormat[EntityTypeKey[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def [B](y: B): (EntityTypeKey[T], B)
    Implicit
    This member is added by an implicit conversion from EntityTypeKey[T] to ArrowAssoc[EntityTypeKey[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from EntityTypeKey[T] to any2stringadd[EntityTypeKey[T]]

Inherited by implicit conversion StringFormat from EntityTypeKey[T] to StringFormat[EntityTypeKey[T]]

Inherited by implicit conversion Ensuring from EntityTypeKey[T] to Ensuring[EntityTypeKey[T]]

Inherited by implicit conversion ArrowAssoc from EntityTypeKey[T] to ArrowAssoc[EntityTypeKey[T]]

Ungrouped