Package akka.stream

Class Attributes

  • All Implemented Interfaces:
    java.io.Serializable, scala.Equals, scala.Product, scala.Serializable

    public final class Attributes
    extends java.lang.Object
    implements scala.Product, scala.Serializable
    Holds attributes which can be used to alter Flow / Flow or GraphDSL / 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.

    See Also:
    Serialized Form
    • Constructor Detail

      • Attributes

        public Attributes​(scala.collection.immutable.List<Attributes.Attribute> attributeList)
    • Method Detail

      • $lessinit$greater$default$1

        public static scala.collection.immutable.List<Attributes.Attribute> $lessinit$greater$default$1()
      • apply

        public static Attributes apply​(Attributes.Attribute attribute)
        INTERNAL API
        Parameters:
        attribute - (undocumented)
        Returns:
        (undocumented)
      • apply$default$1

        public static scala.collection.immutable.List<Attributes.Attribute> apply$default$1()
      • none

        public static Attributes none()
        INTERNAL API
        Returns:
        (undocumented)
      • asyncBoundary

        public static Attributes asyncBoundary()
      • name

        public static Attributes name​(java.lang.String name)
        Specifies the name of the operation. If the name is null or empty the name is ignored, i.e. none() is returned.

        When using this method the name is encoded with URLEncoder with UTF-8 because the name is sometimes used as part of actor name. If that is not desired the name can be added in it's raw format using .addAttributes(Attributes(Name(name))).

        Parameters:
        name - (undocumented)
        Returns:
        (undocumented)
      • inputBuffer

        public static Attributes inputBuffer​(int initial,
                                             int max)
        Specifies the initial and maximum size of the input buffer.
        Parameters:
        initial - (undocumented)
        max - (undocumented)
        Returns:
        (undocumented)
      • createLogLevels

        public static Attributes createLogLevels​(Logging.LogLevel onElement,
                                                 Logging.LogLevel onFinish,
                                                 Logging.LogLevel onFailure)
        Java API

        Configures log() operator log-levels to be used when logging. Logging a certain operation can be completely disabled by using logLevelOff().

        Parameters:
        onElement - (undocumented)
        onFinish - (undocumented)
        onFailure - (undocumented)
        Returns:
        (undocumented)
      • createLogLevels

        public static Attributes createLogLevels​(Logging.LogLevel onElement)
        Java API

        Configures log() operator log-levels to be used when logging onElement. Logging a certain operation can be completely disabled by using logLevelOff().

        Parameters:
        onElement - (undocumented)
        Returns:
        (undocumented)
      • logLevels

        public static Attributes logLevels​(Logging.LogLevel onElement,
                                           Logging.LogLevel onFinish,
                                           Logging.LogLevel onFailure)
        Configures log() operator log-levels to be used when logging. Logging a certain operation can be completely disabled by using LogLevels.Off.

        See Attributes.createLogLevels for Java API

        Parameters:
        onElement - (undocumented)
        onFinish - (undocumented)
        onFailure - (undocumented)
        Returns:
        (undocumented)
      • extractName

        public static java.lang.String extractName​(TraversalBuilder builder,
                                                   java.lang.String default_)
        Compute a name by concatenating all Name attributes that the given module has, returning the given default value if none are found.
        Parameters:
        builder - (undocumented)
        default_ - (undocumented)
        Returns:
        (undocumented)
      • isAsync

        public boolean isAsync()
        Note that this must only be used during traversal building and not during materialization as it will then always return true because of the defaults from the ActorMaterializerSettings INTERNAL API
        Returns:
        (undocumented)
      • getAttribute

        public <T extends Attributes.Attribute> T getAttribute​(java.lang.Class<T> c,
                                                               T default_)
        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.

        Parameters:
        c - (undocumented)
        default_ - (undocumented)
        Returns:
        (undocumented)
      • getAttribute

        public <T extends Attributes.Attribute> java.util.Optional<T> getAttribute​(java.lang.Class<T> c)
        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.

        Parameters:
        c - (undocumented)
        Returns:
        (undocumented)
      • get

        public <T extends Attributes.Attribute> T get​(T default_,
                                                      scala.reflect.ClassTag<T> evidence$1)
        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.

        Parameters:
        default_ - (undocumented)
        evidence$1 - (undocumented)
        Returns:
        (undocumented)
      • get

        public <T extends Attributes.Attribute> scala.Option<T> get​(scala.reflect.ClassTag<T> evidence$2)
        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.

        Parameters:
        evidence$2 - (undocumented)
        Returns:
        (undocumented)
      • mandatoryAttribute

        public <T extends Attributes.MandatoryAttribute> T mandatoryAttribute​(scala.reflect.ClassTag<T> evidence$3)
        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.
        Parameters:
        evidence$3 - (undocumented)
        Returns:
        (undocumented)
      • getMandatoryAttribute

        public <T extends Attributes.MandatoryAttribute> T getMandatoryAttribute​(java.lang.Class<T> c)
        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.

        Parameters:
        c - A class that is a subtype of Attributes.MandatoryAttribute
        Returns:
        (undocumented)
      • and

        public Attributes and​(Attributes other)
        Adds given attributes. Added attributes are considered more specific than already existing attributes of the same type.
        Parameters:
        other - (undocumented)
        Returns:
        (undocumented)
      • and

        public Attributes and​(Attributes.Attribute other)
        Adds given attribute. Added attribute is considered more specific than already existing attributes of the same type.
        Parameters:
        other - (undocumented)
        Returns:
        (undocumented)
      • nameLifted

        public scala.Option<java.lang.String> nameLifted()
        Extracts Name attributes and concatenates them.
        Returns:
        (undocumented)
      • nameOrDefault

        public java.lang.String nameOrDefault​(java.lang.String default_)
        INTERNAL API
        Parameters:
        default_ - (undocumented)
        Returns:
        (undocumented)
      • nameOrDefault$default$1

        public java.lang.String nameOrDefault$default$1()
      • contains

        public boolean contains​(Attributes.Attribute attr)
        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.

        Parameters:
        attr - (undocumented)
        Returns:
        (undocumented)
      • getAttributeList

        public java.util.List<Attributes.Attribute> getAttributeList()
        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.

        Returns:
        (undocumented)
      • getAttributeList

        public <T extends Attributes.Attribute> java.util.List<T> getAttributeList​(java.lang.Class<T> c)
        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.

        Parameters:
        c - (undocumented)
        Returns:
        (undocumented)
      • filtered

        public <T extends Attributes.Attribute> scala.collection.immutable.List<T> filtered​(scala.reflect.ClassTag<T> evidence$4)
        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.

        Parameters:
        evidence$4 - (undocumented)
        Returns:
        (undocumented)
      • getFirstAttribute

        public <T extends Attributes.Attribute> T getFirstAttribute​(java.lang.Class<T> c,
                                                                    T default_)
        Deprecated.
        Attributes should always be most specific, use getAttribute[T]. Since 2.5.7.
        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.
        Parameters:
        c - (undocumented)
        default_ - (undocumented)
        Returns:
        (undocumented)
      • getFirstAttribute

        public <T extends Attributes.Attribute> java.util.Optional<T> getFirstAttribute​(java.lang.Class<T> c)
        Deprecated.
        Attributes should always be most specific, use get[T]. Since 2.5.7.
        Java API: Get the least specific attribute (added first) of a given Class or subclass thereof.
        Parameters:
        c - (undocumented)
        Returns:
        (undocumented)
      • getFirst

        public <T extends Attributes.Attribute> T getFirst​(T default_,
                                                           scala.reflect.ClassTag<T> evidence$5)
        Deprecated.
        Attributes should always be most specific, use get[T]. Since 2.5.7.
        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.
        Parameters:
        default_ - (undocumented)
        evidence$5 - (undocumented)
        Returns:
        (undocumented)
      • getFirst

        public <T extends Attributes.Attribute> scala.Option<T> getFirst​(scala.reflect.ClassTag<T> evidence$6)
        Deprecated.
        Attributes should always be most specific, use get[T]. Since 2.5.7.
        Scala API: Get the least specific attribute (added first) of a given type parameter T Class or subclass thereof.
        Parameters:
        evidence$6 - (undocumented)
        Returns:
        (undocumented)
      • productPrefix

        public java.lang.String productPrefix()
        Specified by:
        productPrefix in interface scala.Product
      • productArity

        public int productArity()
        Specified by:
        productArity in interface scala.Product
      • productElement

        public java.lang.Object productElement​(int x$1)
        Specified by:
        productElement in interface scala.Product
      • productIterator

        public scala.collection.Iterator<java.lang.Object> productIterator()
        Specified by:
        productIterator in interface scala.Product
      • canEqual

        public boolean canEqual​(java.lang.Object x$1)
        Specified by:
        canEqual in interface scala.Equals
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object x$1)
        Specified by:
        equals in interface scala.Equals
        Overrides:
        equals in class java.lang.Object