Package org.apache.pekko.persistence.typed

Class PersistenceId$

java.lang.Object

org.apache.pekko.persistence.typed.PersistenceId$

public class PersistenceId$
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final PersistenceId$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
PersistenceId$()

Method Summary

Modifier and Type	Method	Description
PersistenceId	apply(String entityTypeHint, String entityId)	Constructs a PersistenceId from the given entityTypeHint and entityId by concatenating them with | separator.
PersistenceId	apply(String entityTypeHint, String entityId, String separator)	Constructs a PersistenceId from the given entityTypeHint and entityId by concatenating them with the separator.
String	DefaultSeparator()	Default separator character used for concatenating a typeHint with entityId to construct unique persistenceId.
String	extractEntityId(String id)	Extract the entityId from a persistence id String with the default separator |.
String	extractEntityType(String id)	Extract the entityTypeHint from a persistence id String with the default separator |.
PersistenceId	of(String entityTypeHint, String entityId)	Constructs a PersistenceId from the given entityTypeHint and entityId by concatenating them with | separator.
PersistenceId	of(String entityTypeHint, String entityId, String separator)	Constructs a PersistenceId from the given entityTypeHint and entityId by concatenating them with the separator.
PersistenceId	ofUniqueId(String id)	Constructs a PersistenceId with id as the full unique identifier.
scala.Option<scala.Tuple2<String,String>>	unapply(PersistenceId persistenceId)

Methods inherited from class java.lang.Object

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

Field Details

MODULE$

public static final PersistenceId$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Details

PersistenceId$

public PersistenceId$()

Method Details

DefaultSeparator

public String DefaultSeparator()

Default separator character used for concatenating a typeHint with entityId to construct unique persistenceId.

apply

public PersistenceId apply(String entityTypeHint,
 String entityId)

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

Cluster Sharding is often used together with EventSourcedBehavior for the entities. The PersistenceId of the EventSourcedBehavior can typically be constructed with:

 PersistenceId(entityContext.entityTypeKey.name, entityContext.entityId)
 

That format of the PersistenceId is not mandatory and only provided as a convenience of a "standardized" format.

Another separator can be defined by using the apply that takes a separator parameter.

Throws:

IllegalArgumentException - if the entityTypeHint or entityId contains |

apply

public PersistenceId apply(String entityTypeHint,
 String entityId,
 String separator)

Constructs a PersistenceId from the given entityTypeHint and entityId by concatenating them with the separator.

Cluster Sharding is often used together with EventSourcedBehavior for the entities. The PersistenceId of the EventSourcedBehavior can typically be constructed with:

 PersistenceId(entityContext.entityTypeKey.name, entityContext.entityId)
 

That format of the PersistenceId is not mandatory and only provided as a convenience of a "standardized" format.

The default separator | is used by the apply that doesn't take a separator parameter.

Throws:

IllegalArgumentException - if the entityTypeHint or entityId contains separator

of

public PersistenceId of(String entityTypeHint,
 String entityId)

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

Cluster Sharding is often used together with EventSourcedBehavior for the entities. The PersistenceId of the EventSourcedBehavior can typically be constructed with:

 PersistenceId.of(entityContext.getEntityTypeKey().name(), entityContext.getEntityId())
 

That format of the PersistenceId is not mandatory and only provided as a convenience of a "standardized" format.

Another separator can be defined by using the PersistenceId.of that takes a separator parameter.

Throws:

IllegalArgumentException - if the entityTypeHint or entityId contains |

of

public PersistenceId of(String entityTypeHint,
 String entityId,
 String separator)

Constructs a PersistenceId from the given entityTypeHint and entityId by concatenating them with the separator.

Cluster Sharding is often used together with EventSourcedBehavior for the entities. The PersistenceId of the EventSourcedBehavior can typically be constructed with:

 PersistenceId.of(entityContext.getEntityTypeKey().name(), entityContext.getEntityId())
 

That format of the PersistenceId is not mandatory and only provided as a convenience of a "standardized" format.

The default separator | is used by the apply that doesn't take a separator parameter.

Throws:

IllegalArgumentException - if the entityTypeHint or entityId contains separator

ofUniqueId

public PersistenceId ofUniqueId(String id)

Constructs a PersistenceId with id as the full unique identifier.

extractEntityType

public String extractEntityType(String id)

Extract the entityTypeHint from a persistence id String with the default separator |. If the separator | is not found it return the empty String ("").

extractEntityId

public String extractEntityId(String id)

Extract the entityId from a persistence id String with the default separator |. If the separator | is not found it return the id.

unapply

public scala.Option<scala.Tuple2<String,String>> unapply(PersistenceId persistenceId)