final case class Attributes(attributeList: List[Attribute] = Nil) extends Product with Serializable
Holds attributes which can be used to alter pekko.stream.scaladsl.Flow / pekko.stream.javadsl.Flow or pekko.stream.scaladsl.GraphDSL / pekko.stream.javadsl.GraphDSL materialization.
Note that more attributes for the Materializer are defined in ActorAttributes.
The
is ordered with the most specific attribute first, least specific last.
Note that the order was the opposite in Akka 2.4.x.attributeList
Operators should in general not access the attributeList
but instead use get
to get the expected
value of an attribute.
- Source
- Attributes.scala
- Alphabetic
- By Inheritance
- Attributes
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- def and(other: Attribute): Attributes
Adds given attribute.
Adds given attribute. Added attribute is considered more specific than already existing attributes of the same type.
- def and(other: Attributes): Attributes
Adds given attributes.
Adds given attributes. Added attributes are considered more specific than already existing attributes of the same type.
- val attributeList: List[Attribute]
- def contains(attr: Attribute): Boolean
Test whether the given attribute is contained within this attributes list.
Test whether the given attribute is contained within this attributes list.
Note that operators in general should not inspect the whole hierarchy but instead use
get
to get the most specific attribute value. - def filtered[T <: Attribute](implicit arg0: ClassTag[T]): List[T]
Scala API: Get all attributes of a given type (or subtypes thereof).
Scala API: Get all attributes of a given type (or subtypes thereof).
Note that operators in general should not inspect the whole hierarchy but instead use
get
to get the most specific attribute value.The list is ordered with the most specific attribute first, least specific last. Note that the order was the opposite in Akka 2.4.x.
- def get[T <: Attribute](implicit arg0: ClassTag[T]): Option[T]
Scala API: Get the most specific attribute value for a given Attribute type or subclass thereof.
Scala API: Get the most specific attribute value for a given Attribute type or subclass thereof.
The most specific value is the value that was added closest to the graph or operator itself or if the same attribute was added multiple times to the same graph, the last to be added.
This is the expected way for operators to access attributes.
- See also
Attributes#get For providing a default value if the attribute was not set
- def get[T <: Attribute](default: T)(implicit arg0: ClassTag[T]): T
Scala API: Get the most specific attribute value for a given Attribute type or subclass thereof or if no such attribute exists, return a default value.
Scala API: Get the most specific attribute value for a given Attribute type or subclass thereof or if no such attribute exists, return a default value.
The most specific value is the value that was added closest to the graph or operator itself or if the same attribute was added multiple times to the same graph, the last to be added.
This is the expected way for operators to access attributes.
- def getAttribute[T <: Attribute](c: Class[T]): Optional[T]
Java API: Get the most specific attribute value for a given Attribute type or subclass thereof.
Java API: Get the most specific attribute value for a given Attribute type or subclass thereof.
The most specific value is the value that was added closest to the graph or operator itself or if the same attribute was added multiple times to the same graph, the last to be added.
This is the expected way for operators to access attributes.
- def getAttribute[T <: Attribute](c: Class[T], default: T): T
Java API: Get the most specific attribute value for a given Attribute type or subclass thereof.
Java API: Get the most specific attribute value for a given Attribute type or subclass thereof. If no such attribute exists, return a
default
value.The most specific value is the value that was added closest to the graph or operator itself or if the same attribute was added multiple times to the same graph, the last to be added.
This is the expected way for operators to access attributes.
- def getAttributeList[T <: Attribute](c: Class[T]): List[T]
Java API: Get all attributes of a given
Class
or subclass thereof.Java API: Get all attributes of a given
Class
or subclass thereof.The list is ordered with the most specific attribute first, least specific last. Note that the order was the opposite in Akka 2.4.x.
Note that operators in general should not inspect the whole hierarchy but instead use
get
to get the most specific attribute value. - def getAttributeList(): List[Attribute]
Java API
Java API
The list is ordered with the most specific attribute first, least specific last. Note that the order was the opposite in Akka 2.4.x.
Note that operators in general should not inspect the whole hierarchy but instead use
get
to get the most specific attribute value. - def getMandatoryAttribute[T <: MandatoryAttribute](c: Class[T]): T
Java API: Get the most specific of one of the mandatory attributes.
Java API: Get the most specific of one of the mandatory attributes. Mandatory attributes are guaranteed to always be among the attributes when the attributes are coming from a materialization.
- c
A class that is a subtype of MandatoryAttribute
- def mandatoryAttribute[T <: MandatoryAttribute](implicit arg0: ClassTag[T]): T
Scala API: Get the most specific of one of the mandatory attributes.
Scala API: Get the most specific of one of the mandatory attributes. Mandatory attributes are guaranteed to always be among the attributes when the attributes are coming from a materialization.
- def nameLifted: Option[String]
Extracts Name attributes and concatenates them.
- def nameOrDefault(default: String = "unnamed"): String
- Annotations
- @InternalApi()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
Deprecated Value Members
- def getFirst[T <: Attribute](implicit arg0: ClassTag[T]): Option[T]
Scala API: Get the least specific attribute (added first) of a given type parameter T
Class
or subclass thereof.Scala API: Get the least specific attribute (added first) of a given type parameter T
Class
or subclass thereof.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.7) Attributes should always be most specific, use get[T]
- def getFirst[T <: Attribute](default: T)(implicit arg0: ClassTag[T]): T
Scala API: Get the least specific attribute (added first) of a given type parameter T
Class
or subclass thereof.Scala API: Get the least specific attribute (added first) of a given type parameter T
Class
or subclass thereof. If no such attribute exists thedefault
value is returned.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.7) Attributes should always be most specific, use get[T]
- def getFirstAttribute[T <: Attribute](c: Class[T]): Optional[T]
Java API: Get the least specific attribute (added first) of a given
Class
or subclass thereof.Java API: Get the least specific attribute (added first) of a given
Class
or subclass thereof.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.7) Attributes should always be most specific, use get[T]
- def getFirstAttribute[T <: Attribute](c: Class[T], default: T): T
Java API: Get the least specific attribute (added first) of a given
Class
or subclass thereof.Java API: Get the least specific attribute (added first) of a given
Class
or subclass thereof. If no such attribute exists thedefault
value is returned.- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.7) Attributes should always be most specific, use getAttribute[T]