Package org.apache.pekko.actor.typed

Class ActorTags

java.lang.Object

org.apache.pekko.actor.typed.Props

org.apache.pekko.actor.typed.ActorTags

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

Direct Known Subclasses:

PropsImpl.ActorTagsImpl

public abstract class ActorTags
extends Props

Actor tags are used to logically group actors. The tags are included in logging as markers Especially useful for logging from functional style actors and since those may not have a clear logger class.

Not for user extension.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ActorTags()

Method Summary

Modifier and Type	Method	Description
static ActorTags	apply(String tag, scala.collection.immutable.Seq<String> additionalTags)	Scala API: create a tag props with one or more tags
static ActorTags	apply(scala.collection.immutable.Set<String> tags)	Scala API: create a multi-tag props.
static ActorTags	create(String... tags)	Java API: create a tag props with one or more tags
static ActorTags	create(Set<String> tags)	Java API: create a multi-tag props
static ActorTags	create(scala.collection.immutable.Seq<String> tags)	Java API: create a tag props with one or more tags
Set<String>	getTags()	Java API: one or more tags defined for the actor
abstract scala.collection.immutable.Set<String>	tags()	Scala API: one or more tags defined for the actor

Methods inherited from class org.apache.pekko.actor.typed.Props

empty, withDispatcherDefault, withDispatcherFromConfig, withDispatcherSameAsParent, withMailboxFromConfig

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details

ActorTags

public ActorTags()

Method Details

create

public static ActorTags create(String... tags)

Java API: create a tag props with one or more tags

create

public static ActorTags create(scala.collection.immutable.Seq<String> tags)

Java API: create a tag props with one or more tags

create

public static ActorTags create(Set<String> tags)

Java API: create a multi-tag props

Set must not be empty.

apply

public static ActorTags apply(String tag,
 scala.collection.immutable.Seq<String> additionalTags)

Scala API: create a tag props with one or more tags

apply

public static ActorTags apply(scala.collection.immutable.Set<String> tags)

Scala API: create a multi-tag props.

Set must not be empty.

tags

public abstract scala.collection.immutable.Set<String> tags()

Scala API: one or more tags defined for the actor

Returns:

getTags

public Set<String> getTags()

Java API: one or more tags defined for the actor