akka.stream

Class Attributes

java.lang.Object

akka.stream.Attributes

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attributes.AsyncBoundary$
static interface	Attributes.Attribute
static class	Attributes.InputBuffer
static class	Attributes.InputBuffer$
static class	Attributes.LogLevels
static class	Attributes.LogLevels$
static class	Attributes.Name
static class	Attributes.Name$

Constructor Summary

Constructors

Constructor and Description
Attributes(scala.collection.immutable.List<Attributes.Attribute> attributeList)

Method Summary

Modifier and Type	Method and Description
Attributes	and(Attributes.Attribute other) Adds given attribute to the end of these attributes.
Attributes	and(Attributes other) Adds given attributes to the end of these attributes.
static Attributes	apply(Attributes.Attribute attribute) INTERNAL API
static Attributes	asyncBoundary()
scala.collection.immutable.List<Attributes.Attribute>	attributeList()
abstract static boolean	canEqual(java.lang.Object that)
boolean	contains(Attributes.Attribute attr) Test whether the given attribute is contained within this attributes list.
static Attributes	createLogLevels(Logging.LogLevel onElement, Logging.LogLevel onFinish, Logging.LogLevel onFailure) Java API
abstract static boolean	equals(java.lang.Object that)
static java.lang.String	extractName(StreamLayout.Module mod, 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.
<T extends Attributes.Attribute> scala.collection.immutable.List<T>	filtered(scala.reflect.ClassTag<T> evidence$1) Scala API: get all attributes of a given type (or subtypes thereof).
<T extends Attributes.Attribute> scala.Option<T>	get(scala.reflect.ClassTag<T> evidence$4) Scala API: Get the last (most specific) attribute of a given type parameter T Class or subclass thereof.
<T extends Attributes.Attribute> T	get(T default_, scala.reflect.ClassTag<T> evidence$2) Scala API: Get the last (most specific) attribute of a given type parameter T Class or subclass thereof.
<T extends Attributes.Attribute> java.util.Optional<T>	getAttribute(java.lang.Class<T> c) Java API: Get the last (most specific) attribute of a given Class or subclass thereof.
<T extends Attributes.Attribute> T	getAttribute(java.lang.Class<T> c, T default_) Java API: Get the last (most specific) attribute of a given Class or subclass thereof.
java.util.List<Attributes.Attribute>	getAttributeList() Java API
<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.
<T extends Attributes.Attribute> scala.Option<T>	getFirst(scala.reflect.ClassTag<T> evidence$5) Scala API: Get the first (least specific) attribute of a given type parameter T Class or subclass thereof.
<T extends Attributes.Attribute> T	getFirst(T default_, scala.reflect.ClassTag<T> evidence$3) Scala API: Get the first (least specific) attribute of a given type parameter T Class or subclass thereof.
<T extends Attributes.Attribute> java.util.Optional<T>	getFirstAttribute(java.lang.Class<T> c) Java API: Get the first (least specific) attribute of a given Class or subclass thereof.
<T extends Attributes.Attribute> T	getFirstAttribute(java.lang.Class<T> c, T default_) Java API: Get the first (least specific) attribute of a given Class or subclass thereof.
static Attributes	inputBuffer(int initial, int max) Specifies the initial and maximum size of the input buffer.
static Attributes	logLevels(Logging.LogLevel onElement, Logging.LogLevel onFinish, Logging.LogLevel onFailure) Configures log() stage log-levels to be used when logging.
static Attributes	name(java.lang.String name) Specifies the name of the operation.
scala.Option<java.lang.String>	nameLifted() Extracts Name attributes and concatenates them.
java.lang.String	nameOrDefault(java.lang.String default_) INTERNAL API
static Attributes	none() INTERNAL API
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

Attributes

public Attributes(scala.collection.immutable.List<Attributes.Attribute> attributeList)

Method Detail

apply

public static Attributes apply(Attributes.Attribute attribute)

INTERNAL API

Parameters:

attribute - (undocumented)

Returns:

(undocumented)

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.

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() stage log-levels to be used when logging. Logging a certain operation can be completely disabled by using LogLevels.Off.

Passing in null as any of the arguments sets the level to its default value, which is: Debug for onElement and onFinish, and Error for onFailure.

Parameters:

onElement - (undocumented)

onFinish - (undocumented)

onFailure - (undocumented)

Returns:

(undocumented)

logLevels

public static Attributes logLevels(Logging.LogLevel onElement,
                                   Logging.LogLevel onFinish,
                                   Logging.LogLevel onFailure)

Configures log() stage 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(StreamLayout.Module mod,
                                           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:

mod - (undocumented)

default_ - (undocumented)

Returns:

(undocumented)

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

attributeList

public scala.collection.immutable.List<Attributes.Attribute> attributeList()

getAttributeList

public java.util.List<Attributes.Attribute> getAttributeList()

Java API

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.

Parameters:

c - (undocumented)

Returns:

(undocumented)

getAttribute

public <T extends Attributes.Attribute> T getAttribute(java.lang.Class<T> c,
                                                       T default_)

Java API: Get the last (most specific) attribute 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> T getFirstAttribute(java.lang.Class<T> c,
                                                            T default_)

Java API: Get the first (least specific) attribute of a given Class or subclass thereof. If no such attribute exists the default value is returned.

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 last (most specific) attribute of a given Class or subclass thereof.

Parameters:

c - (undocumented)

Returns:

(undocumented)

getFirstAttribute

public <T extends Attributes.Attribute> java.util.Optional<T> getFirstAttribute(java.lang.Class<T> c)

Java API: Get the first (least specific) attribute of a given Class or subclass thereof.

Parameters:

c - (undocumented)

Returns:

(undocumented)

filtered

public <T extends Attributes.Attribute> scala.collection.immutable.List<T> filtered(scala.reflect.ClassTag<T> evidence$1)

Scala API: get all attributes of a given type (or subtypes thereof).

Parameters:

evidence$1 - (undocumented)

Returns:

(undocumented)

get

public <T extends Attributes.Attribute> T get(T default_,
                                              scala.reflect.ClassTag<T> evidence$2)

Scala API: Get the last (most specific) attribute of a given type parameter T Class or subclass thereof. If no such attribute exists the default value is returned.

Parameters:

default_ - (undocumented)

evidence$2 - (undocumented)

Returns:

(undocumented)

getFirst

public <T extends Attributes.Attribute> T getFirst(T default_,
                                                   scala.reflect.ClassTag<T> evidence$3)

Scala API: Get the first (least specific) attribute of a given type parameter T Class or subclass thereof. If no such attribute exists the default value is returned.

Parameters:

default_ - (undocumented)

evidence$3 - (undocumented)

Returns:

(undocumented)

get

public <T extends Attributes.Attribute> scala.Option<T> get(scala.reflect.ClassTag<T> evidence$4)

Scala API: Get the last (most specific) attribute of a given type parameter T Class or subclass thereof.

Parameters:

evidence$4 - (undocumented)

Returns:

(undocumented)

getFirst

public <T extends Attributes.Attribute> scala.Option<T> getFirst(scala.reflect.ClassTag<T> evidence$5)

Scala API: Get the first (least specific) attribute of a given type parameter T Class or subclass thereof.

Parameters:

evidence$5 - (undocumented)

Returns:

(undocumented)

contains

public boolean contains(Attributes.Attribute attr)

Test whether the given attribute is contained within this attributes list.

Parameters:

attr - (undocumented)

Returns:

(undocumented)

and

public Attributes and(Attributes other)

Adds given attributes to the end of these attributes.

Parameters:

other - (undocumented)

Returns:

(undocumented)

and

public Attributes and(Attributes.Attribute other)

Adds given attribute to the end of these attributes.

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)