Class/Object

akka.stream

Attributes

Related Docs: object Attributes | package stream

Permalink

final case class Attributes(attributeList: List[Attribute] = Nil) extends Product with Serializable

Holds attributes which can be used to alter akka.stream.scaladsl.Flow / akka.stream.javadsl.Flow or akka.stream.scaladsl.GraphDSL / akka.stream.javadsl.GraphDSL materialization.

Note that more attributes for the ActorMaterializer are defined in ActorAttributes.

The attributeList is ordered with the most specific attribute first, least specific last. Note that the order was the opposite in Akka 2.4.x.

Operators should in general not access the attributeList but instead use get to get the expected value of an attribute.

Source
Attributes.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Attributes
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. 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

Instance Constructors

  1. new Attributes(attributeList: List[Attribute] = Nil)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attributes to any2stringadd[Attributes] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Attributes, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attributes to ArrowAssoc[Attributes] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. def and(other: Attribute): Attributes

    Permalink

    Adds given attribute.

    Adds given attribute. Added attribute is considered more specific than already existing attributes of the same type.

  7. def and(other: Attributes): Attributes

    Permalink

    Adds given attributes.

    Adds given attributes. Added attributes are considered more specific than already existing attributes of the same type.

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  9. val attributeList: List[Attribute]

    Permalink

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. def contains(attr: Attribute): Boolean

    Permalink

    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.

  12. def ensuring(cond: (Attributes) ⇒ Boolean, msg: ⇒ Any): Attributes

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attributes to Ensuring[Attributes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: (Attributes) ⇒ Boolean): Attributes

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attributes to Ensuring[Attributes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean, msg: ⇒ Any): Attributes

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attributes to Ensuring[Attributes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: Boolean): Attributes

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attributes to Ensuring[Attributes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. def filtered[T <: Attribute](implicit arg0: ClassTag[T]): List[T]

    Permalink

    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.

  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attributes to StringFormat[Attributes] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  20. def get[T <: Attribute](implicit arg0: ClassTag[T]): Option[T]

    Permalink

    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

  21. def get[T <: Attribute](default: T)(implicit arg0: ClassTag[T]): T

    Permalink

    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.

  22. def getAttribute[T <: Attribute](c: Class[T]): Optional[T]

    Permalink

    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.

  23. def getAttribute[T <: Attribute](c: Class[T], default: T): T

    Permalink

    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.

  24. def getAttributeList[T <: Attribute](c: Class[T]): List[T]

    Permalink

    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.

  25. def getAttributeList(): List[Attribute]

    Permalink

    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.

  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  27. def getMandatoryAttribute[T <: MandatoryAttribute](c: Class[T]): T

    Permalink

    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

  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  29. def mandatoryAttribute[T <: MandatoryAttribute](implicit arg0: ClassTag[T]): T

    Permalink

    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.

  30. def nameLifted: Option[String]

    Permalink

    Extracts Name attributes and concatenates them.

  31. def nameOrDefault(default: String = "unnamed"): String

    Permalink

    INTERNAL API

    INTERNAL API

    Annotations
    @InternalApi()

  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  36. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  38. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  39. def →[B](y: B): (Attributes, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Attributes to ArrowAssoc[Attributes] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def getFirst[T <: Attribute](implicit arg0: ClassTag[T]): Option[T]

    Permalink

    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 2.5.7) Attributes should always be most specific, use get[T]

  2. def getFirst[T <: Attribute](default: T)(implicit arg0: ClassTag[T]): T

    Permalink

    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 the default value is returned.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.7) Attributes should always be most specific, use get[T]

  3. def getFirstAttribute[T <: Attribute](c: Class[T]): Optional[T]

    Permalink

    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 2.5.7) Attributes should always be most specific, use get[T]

  4. def getFirstAttribute[T <: Attribute](c: Class[T], default: T): T

    Permalink

    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 the default value is returned.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.7) Attributes should always be most specific, use getAttribute[T]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Attributes to any2stringadd[Attributes]

Inherited by implicit conversion StringFormat from Attributes to StringFormat[Attributes]

Inherited by implicit conversion Ensuring from Attributes to Ensuring[Attributes]

Inherited by implicit conversion ArrowAssoc from Attributes to ArrowAssoc[Attributes]

Ungrouped