Modifier and Type	Class and Description
public static class	Scannable.Attr< the type of data associated with an attribute T> Base class for `Scannable` attributes, which all can define a meaningful default.

Modifier and Type	Field and Description
public static final Pattern	OPERATOR_NAME_UNRELATED_WORDS_PATTERN The pattern for matching words unrelated to operator name.

Method Summary

Modifier and Type	Method and Description
public default Stream<? extends Scannable>	Returns: a `Stream` navigating the `org.reactivestreams.Subscriber` chain (downward, current `Scannable` not included). actuals() Return a `Stream` navigating the `org.reactivestreams.Subscriber` chain (downward).
public static Scannable	Returns: the casted `Scannable`, or one of two default `Scannable` instances that aren't actually scannable (one for nulls, one for non-scannable references) from(Object a reference to cast o) Attempt to cast the Object to a `Scannable`.
public default Stream<? extends Scannable>	Returns: a `Stream` of referenced inners (flatmap, multicast etc) inners() Return a `Stream` of referenced inners (flatmap, multicast etc)
public default boolean	Returns: true whether the component is available for `scan(Attr)` resolution. isScanAvailable() Return true whether the component is available for `scan(Attr)` resolution.
public default String	Returns: the name of the first parent that has one defined (including this scannable) name() Check this `Scannable` and its `parents()` for a user-defined name and return the first one that is reachable, or default to this `Scannable` `stepName()` if none.
public default Stream<? extends Scannable>	Returns: a `Stream` navigating the `org.reactivestreams.Subscription` chain (upward, current `Scannable` not included). parents() Return a `Stream` navigating the `org.reactivestreams.Subscription` chain (upward).
public default <T> T	Returns: a value associated to the key or null if unmatched or unresolved scan(Scannable.Attr<T> a `Attr` to resolve for the component. key) Introspect a component's specific state `attribute`, returning an associated value specific to that component, or the default value associated with the key, or null if the attribute doesn't make sense for that particular component and has no sensible default.
public default <T> T	Returns: a value associated to the key or the provided default if unmatched or unresolved scanOrDefault(Scannable.Attr<T> a `Attr` to resolve for the component. key, T a fallback value if key resolve to null defaultValue) Introspect a component's specific state `attribute`.
public Object	Returns: the value associated to the key for that specific component, or null if none. scanUnsafe(Scannable.Attr<T> a `Attr` to resolve for the component. key) This method is used internally by components to define their key-value mappings in a single place.
public default String	stepName() Return a meaningful `String` representation of this `Scannable` in its chain of `parents()` and `actuals()`.
public default Stream<String>	Returns: a `Stream` of `stepName()` for each discovered step in the `Scannable` chain steps() List the step names in the chain of `Scannable` (including the current element), in their assembly order.
public default Stream<Tuple2<String, String>>	Returns: the stream of tags for this `Scannable` and its reachable parents, including duplicates tags() Visit this `Scannable` and its `parents()`, starting by the furthest reachable parent, and return a `Stream` of the tags which includes duplicates and outputs tags in declaration order (grandparent tag(s) > parent tag(s) > current tag(s)).
public default Map<String, String>	Returns: a `Map` of deduplicated tags from this `Scannable` and its reachable parents tagsDeduplicated() Visit this `Scannable` and its `parents()`, starting by the furthest reachable parent, deduplicate tags that have a common key by favoring the value declared last (current tag(s) > parent tag(s) > grandparent tag(s)) and return a `Map` of the deduplicated tags.

Field Detail

OPERATOR_NAME_UNRELATED_WORDS_PATTERN	back to summary
public static final Pattern OPERATOR_NAME_UNRELATED_WORDS_PATTERN The pattern for matching words unrelated to operator name. Used to strip an operator name of various prefixes and suffixes.

Method Detail

actuals back to summary

actuals	back to summary
public default Stream<? extends Scannable> actuals() Return a `Stream` navigating the `org.reactivestreams.Subscriber` chain (downward). The current `Scannable` is not included. Returns:Stream<? extends Scannable> a `Stream` navigating the `org.reactivestreams.Subscriber` chain (downward, current `Scannable` not included).

public default Stream<? extends Scannable> actuals()

Return a Stream navigating the org.reactivestreams.Subscriber chain (downward). The current Scannable is not included.

Returns:Stream<? extends Scannable>: a Stream navigating the org.reactivestreams.Subscriber chain (downward, current Scannable not included).

from back to summary

from	back to summary
public static Scannable from(Object o) Attempt to cast the Object to a `Scannable`. Return `Attr#NULL_SCAN` if the value is null, or `Attr#UNAVAILABLE_SCAN` if the value is not a `Scannable`. Both are constant `Scannable` that return false on `Scannable#isScanAvailable`. Parameters o:Object a reference to cast Returns:Scannable the casted `Scannable`, or one of two default `Scannable` instances that aren't actually scannable (one for nulls, one for non-scannable references)

public static Scannable from(Object o)

Attempt to cast the Object to a Scannable. Return Attr#NULL_SCAN if the value is null, or Attr#UNAVAILABLE_SCAN if the value is not a Scannable. Both are constant Scannable that return false on Scannable#isScanAvailable.

Parameters

o:Object: a reference to cast

Returns:Scannable

the casted Scannable, or one of two default Scannable instances that aren't actually scannable (one for nulls, one for non-scannable references)

inners back to summary

inners	back to summary
public default Stream<? extends Scannable> inners() Return a `Stream` of referenced inners (flatmap, multicast etc) Returns:Stream<? extends Scannable> a `Stream` of referenced inners (flatmap, multicast etc)

public default Stream<? extends Scannable> inners()

Return a Stream of referenced inners (flatmap, multicast etc)

Returns:Stream<? extends Scannable>: a Stream of referenced inners (flatmap, multicast etc)

isScanAvailable back to summary

isScanAvailable	back to summary
public default boolean isScanAvailable() Return true whether the component is available for `scan(Attr)` resolution. Returns:boolean true whether the component is available for `scan(Attr)` resolution.

public default boolean isScanAvailable()

Return true whether the component is available for scan(Attr) resolution.

Returns:boolean: true whether the component is available for scan(Attr) resolution.

name back to summary

name	back to summary
public default String name() Check this `Scannable` and its `parents()` for a user-defined name and return the first one that is reachable, or default to this `Scannable` `stepName()` if none. Returns:String the name of the first parent that has one defined (including this scannable)

public default String name()

Check this Scannable and its parents() for a user-defined name and return the first one that is reachable, or default to this Scannable stepName() if none.

Returns:String: the name of the first parent that has one defined (including this scannable)

parents back to summary

parents	back to summary
public default Stream<? extends Scannable> parents() Return a `Stream` navigating the `org.reactivestreams.Subscription` chain (upward). The current `Scannable` is not included. Returns:Stream<? extends Scannable> a `Stream` navigating the `org.reactivestreams.Subscription` chain (upward, current `Scannable` not included).

public default Stream<? extends Scannable> parents()

Return a Stream navigating the org.reactivestreams.Subscription chain (upward). The current Scannable is not included.

Returns:Stream<? extends Scannable>: a Stream navigating the org.reactivestreams.Subscription chain (upward, current Scannable not included).

scan back to summary

scan	back to summary
public default <T> T scan(Scannable.Attr<T> key) Introspect a component's specific state `attribute`, returning an associated value specific to that component, or the default value associated with the key, or null if the attribute doesn't make sense for that particular component and has no sensible default. Parameters key:Scannable.Attr<T> a `Attr` to resolve for the component. Returns:T a value associated to the key or null if unmatched or unresolved Annotations @Nullable

public default <T> T scan(Scannable.Attr<T> key)

Introspect a component's specific state attribute, returning an associated value specific to that component, or the default value associated with the key, or null if the attribute doesn't make sense for that particular component and has no sensible default.

Parameters

key:Scannable.Attr<T>: a Attr to resolve for the component.

Returns:T

a value associated to the key or null if unmatched or unresolved

Annotations

@Nullable

scanOrDefault back to summary

scanOrDefault	back to summary
public default <T> T scanOrDefault(Scannable.Attr<T> key, T defaultValue) Introspect a component's specific state `attribute`. If there's no specific value in the component for that key, fall back to returning the provided non null default. Parameters key:Scannable.Attr<T> a `Attr` to resolve for the component. defaultValue:T a fallback value if key resolve to null Returns:T a value associated to the key or the provided default if unmatched or unresolved

public default <T> T scanOrDefault(Scannable.Attr<T> key, T defaultValue)

Introspect a component's specific state attribute. If there's no specific value in the component for that key, fall back to returning the provided non null default.

Parameters

key:Scannable.Attr<T>: a Attr to resolve for the component.
defaultValue:T: a fallback value if key resolve to null

Returns:T

a value associated to the key or the provided default if unmatched or unresolved

scanUnsafe back to summary

scanUnsafe	back to summary
public Object scanUnsafe(Scannable.Attr<T> key) This method is used internally by components to define their key-value mappings in a single place. Although it is ignoring the generic type of the `Attr` key, implementors should take care to return values of the correct type, and return null if no specific value is available. For public consumption of attributes, prefer using `scan(Attr)`, which will return a typed value and fall back to the key's default if the component didn't define any mapping. Parameters key:Scannable.Attr<T> a `Attr` to resolve for the component. Returns:Object the value associated to the key for that specific component, or null if none. Annotations @Nullable

public Object scanUnsafe(Scannable.Attr<T> key)

This method is used internally by components to define their key-value mappings in a single place. Although it is ignoring the generic type of the Attr key, implementors should take care to return values of the correct type, and return null if no specific value is available.

For public consumption of attributes, prefer using scan(Attr), which will return a typed value and fall back to the key's default if the component didn't define any mapping.

Parameters

key:Scannable.Attr<T>: a Attr to resolve for the component.

Returns:Object

the value associated to the key for that specific component, or null if none.

Annotations

@Nullable

stepName	back to summary
public default String stepName() Return a meaningful `String` representation of this `Scannable` in its chain of `parents()` and `actuals()`.

steps back to summary

steps	back to summary
public default Stream<String> steps() List the step names in the chain of `Scannable` (including the current element), in their assembly order. This traverses the chain of `Scannable` both upstream (`parents()`) and downstream (`actuals()`). if the current Scannable is a `Subscriber`, the chain can reach down to the final subscriber, provided it is `Scannable` (eg. lambda subscriber) if it is an operator the chain can reach up to the source, if it is a Reactor source (that is `Scannable`). Returns:Stream<String> a `Stream` of `stepName()` for each discovered step in the `Scannable` chain

public default Stream<String> steps()

List the step names in the chain of Scannable (including the current element), in their assembly order. This traverses the chain of Scannable both upstream (parents()) and downstream (actuals()).

if the current Scannable is a Subscriber, the chain can reach down to the final subscriber, provided it is Scannable (eg. lambda subscriber)
if it is an operator the chain can reach up to the source, if it is a Reactor source (that is Scannable).

Returns:Stream<String>: a Stream of stepName() for each discovered step in the Scannable chain

tags back to summary

tags	back to summary
public default Stream<Tuple2<String, String>> tags() Visit this `Scannable` and its `parents()`, starting by the furthest reachable parent, and return a `Stream` of the tags which includes duplicates and outputs tags in declaration order (grandparent tag(s) > parent tag(s) > current tag(s)). Tags can only be discovered until no parent can be inspected, which happens either when the source publisher has been reached or when a non-reactor intermediate operator is present in the parent chain (i.e. a stage that is not `Scannable` for `Attr#PARENT`). Returns:Stream<Tuple2<String, String>> the stream of tags for this `Scannable` and its reachable parents, including duplicates See Also `tagsDeduplicated()`

public default Stream<Tuple2<String, String>> tags()

Visit this Scannable and its parents(), starting by the furthest reachable parent, and return a Stream of the tags which includes duplicates and outputs tags in declaration order (grandparent tag(s) > parent tag(s) > current tag(s)).

Tags can only be discovered until no parent can be inspected, which happens either when the source publisher has been reached or when a non-reactor intermediate operator is present in the parent chain (i.e. a stage that is not Scannable for Attr#PARENT).

Returns:Stream<Tuple2<String, String>>: the stream of tags for this Scannable and its reachable parents, including duplicates
See Also: tagsDeduplicated()

tagsDeduplicated back to summary

tagsDeduplicated	back to summary
public default Map<String, String> tagsDeduplicated() Visit this `Scannable` and its `parents()`, starting by the furthest reachable parent, deduplicate tags that have a common key by favoring the value declared last (current tag(s) > parent tag(s) > grandparent tag(s)) and return a `Map` of the deduplicated tags. Note that while the values are the "latest", the key iteration order reflects the tags' declaration order. Tags can only be discovered until no parent can be inspected, which happens either when the source publisher has been reached or when a non-reactor intermediate operator is present in the parent chain (i.e. a stage that is not `Scannable` for `Attr#PARENT`). Returns:Map<String, String> a `Map` of deduplicated tags from this `Scannable` and its reachable parents See Also `tags()`

public default Map<String, String> tagsDeduplicated()

Visit this Scannable and its parents(), starting by the furthest reachable parent, deduplicate tags that have a common key by favoring the value declared last (current tag(s) > parent tag(s) > grandparent tag(s)) and return a Map of the deduplicated tags. Note that while the values are the "latest", the key iteration order reflects the tags' declaration order.

Returns:Map<String, String>: a Map of deduplicated tags from this Scannable and its reachable parents
See Also: tags()

reactor.core back to summary

public Class Scannable.Attr<T>

Class Inheritance

extends Object

java.lang.Object
reactor.core.Scannable.Attr

Known Direct Subclasses

reactor.core.publisher.InternalProducerAttr

Type Parameters

<T>: the type of data associated with an attribute

Base class for Scannable attributes, which all can define a meaningful default.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Scannable.Attr.RunStyle An `Enum` enumerating the different styles an operator can run : their `ordinal()` reflects the level of confidence in their running mode

Field Summary

Modifier and Type	Field and Description
public static final Scannable.Attr<Scannable>	ACTUAL The direct dependent component downstream reference if any.
public static final Scannable.Attr<Boolean>	ACTUAL_METADATA Indicate that for some purposes a `Scannable` should be used as additional source of information about a contiguous `Scannable` in the chain.
public static final Scannable.Attr<Integer>	BUFFERED A `Integer` attribute implemented by components with a backlog capacity.
public static final Scannable.Attr<Boolean>	CANCELLED A `Boolean` attribute indicating whether or not a downstream component has interrupted consuming this scanned component, e.g., a cancelled subscription.
public static final Scannable.Attr<Integer>	CAPACITY Return an an `Integer` capacity when no `PREFETCH` is defined or when an arbitrary maximum limit is applied to the backlog capacity of the scanned component.
pack-priv final T	defaultValue
public static final Scannable.Attr<Boolean>	DELAY_ERROR Delay_Error exposes a `Boolean` whether the scanned component actively supports error delaying if it manages a backlog instead of fast error-passing which might drop pending backlog.
public static final Scannable.Attr<Throwable>	ERROR a `Throwable` attribute which indicate an error state if the scanned component keeps track of it.
public static final Scannable.Attr<Long>	LARGE_BUFFERED Similar to `Attr#BUFFERED`, but reserved for operators that can hold a backlog of items that can grow beyond Integer.MAX_VALUE.
public static final Scannable.Attr<String>	LIFTER LIFTER attribute exposes name of the lifter function.
public static final Scannable.Attr<String>	NAME An arbitrary name given to the operator component.
pack-priv static final Scannable	NULL_SCAN A constant that represents `Scannable` returned via `from(Object)` when the passed reference is null
public static final Scannable.Attr<Scannable>	PARENT Parent key exposes the direct upstream relationship of the scanned component.
public static final Scannable.Attr<Integer>	PREFETCH Prefetch is an `Integer` attribute defining the rate of processing in a component which has capacity to request and hold a backlog of data.
public static final Scannable.Attr<Long>	REQUESTED_FROM_DOWNSTREAM A `Long` attribute exposing the current pending demand of a downstream component.
public static final Scannable.Attr<Scannable>	RUN_ON A key that links a `Scannable` to another `Scannable` it runs on.
public static final Scannable.Attr<Scannable.Attr.RunStyle>	RUN_STYLE An `RunStyle` enum attribute indicating whether or not an operator continues to operate on the same thread.
pack-priv final Function<Object, ? extends T>	safeConverter
public static final Scannable.Attr<Stream<Tuple2<String, String>>>	TAGS A `Stream` of `reactor.util.function.Tuple2` representing key/value pairs for tagged components.
public static final Scannable.Attr<Boolean>	TERMINATED A `Boolean` attribute indicating whether or not an upstream component terminated this scanned component.
pack-priv static final Scannable	UNAVAILABLE_SCAN A constant that represents `Scannable` returned via `from(Object)` when the passed non-null reference is not a `Scannable`

Constructor Summary

Access	Constructor and Description
protected	Attr(T defaultValue)
protected	Attr(T defaultValue, Function<Object, ? extends T> safeConverter)

Method Summary

Modifier and Type	Method and Description
public T	Returns: the default value applicable to all components or null if none. defaultValue() Meaningful and always applicable default value for the attribute, returned instead of null when a specific value hasn't been defined for a component.
pack-priv boolean	Returns: true if the attribute can safely convert any object, false if it can throw `ClassCastException` isConversionSafe() Checks if this attribute is capable of safely converting any Object into a `T` via `tryConvert(Object)` (potentially returning `null` or a Null Object for incompatible raw values).
pack-priv static Stream<? extends Scannable>	recurse(Scannable _s, Scannable.Attr<Scannable> key)
pack-priv T	Returns: the converted instance tryConvert(Object the instance to attempt conversion on o) Attempt to convert any `Object` instance o into a `T`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ACTUAL back to summary

ACTUAL	back to summary
public static final Scannable.Attr<Scannable> ACTUAL The direct dependent component downstream reference if any. Operators in Flux/Mono for instance delegate to a target Subscriber, which is going to be the actual chain navigated with this reference key. Subscribers are not always `Scannable`, but this attribute will convert these raw results to an `unavailable scan` object in this case. A reference chain downstream can be navigated via `Scannable#actuals()`.

public static final Scannable.Attr<Scannable> ACTUAL

The direct dependent component downstream reference if any. Operators in Flux/Mono for instance delegate to a target Subscriber, which is going to be the actual chain navigated with this reference key. Subscribers are not always Scannable, but this attribute will convert these raw results to an unavailable scan object in this case.

A reference chain downstream can be navigated via Scannable#actuals().

ACTUAL_METADATA back to summary

public static final Scannable.Attr<Boolean> ACTUAL_METADATA

Indicate that for some purposes a Scannable should be used as additional source of information about a contiguous Scannable in the chain.

For example Scannable#steps() uses this to collate the stepName of an assembly trace to its wrapped operator (the one before it in the assembly chain).

BUFFERED back to summary

BUFFERED	back to summary
public static final Scannable.Attr<Integer> BUFFERED A `Integer` attribute implemented by components with a backlog capacity. It will expose current queue size or similar related to user-provided held data. Note that some operators and processors CAN keep a backlog larger than `Integer.MAX_VALUE`, in which case the `Attr` LARGE_BUFFERED should be used instead. Such operators will attempt to serve a BUFFERED query but will return `Integer#MIN_VALUE` when actual buffer size is oversized for int.

public static final Scannable.Attr<Integer> BUFFERED

A Integer attribute implemented by components with a backlog capacity. It will expose current queue size or similar related to user-provided held data. Note that some operators and processors CAN keep a backlog larger than Integer.MAX_VALUE, in which case the Attr LARGE_BUFFERED should be used instead. Such operators will attempt to serve a BUFFERED query but will return Integer#MIN_VALUE when actual buffer size is oversized for int.

CANCELLED	back to summary
public static final Scannable.Attr<Boolean> CANCELLED A `Boolean` attribute indicating whether or not a downstream component has interrupted consuming this scanned component, e.g., a cancelled subscription. Note that it differs from `TERMINATED` which is intended for "normal" shutdown cycles.

CAPACITY	back to summary
public static final Scannable.Attr<Integer> CAPACITY Return an an `Integer` capacity when no `PREFETCH` is defined or when an arbitrary maximum limit is applied to the backlog capacity of the scanned component. `Integer#MAX_VALUE` signal unlimited capacity. Note This attribute usually resolves to a constant value.

defaultValue	back to summary
pack-priv final T defaultValue

DELAY_ERROR	back to summary
public static final Scannable.Attr<Boolean> DELAY_ERROR Delay_Error exposes a `Boolean` whether the scanned component actively supports error delaying if it manages a backlog instead of fast error-passing which might drop pending backlog. Note This attribute usually resolves to a constant value.

ERROR	back to summary
public static final Scannable.Attr<Throwable> ERROR a `Throwable` attribute which indicate an error state if the scanned component keeps track of it.

LARGE_BUFFERED back to summary

LARGE_BUFFERED	back to summary
public static final Scannable.Attr<Long> LARGE_BUFFERED Similar to `Attr#BUFFERED`, but reserved for operators that can hold a backlog of items that can grow beyond Integer.MAX_VALUE. These operators will also answer to a `Attr#BUFFERED` query up to the point where their buffer is actually too large, at which point they'll return Integer.MIN_VALUE, which serves as a signal that this attribute should be used instead. Defaults to null. `Flux.flatMap`, `Flux.filterWhen` and `Flux.window` (with overlap) are known to use this attribute.

public static final Scannable.Attr<Long> LARGE_BUFFERED

Similar to Attr#BUFFERED, but reserved for operators that can hold a backlog of items that can grow beyond Integer.MAX_VALUE. These operators will also answer to a Attr#BUFFERED query up to the point where their buffer is actually too large, at which point they'll return Integer.MIN_VALUE, which serves as a signal that this attribute should be used instead. Defaults to null.

Flux.flatMap, Flux.filterWhen and Flux.window (with overlap) are known to use this attribute.

LIFTER	back to summary
public static final Scannable.Attr<String> LIFTER LIFTER attribute exposes name of the lifter function. It is calculated as `Object#toString` of a function passed to the `reactor.core.publisher.Operators#lift` or `reactor.core.publisher.Operators#liftPublisher`. Defaults to null.

NAME	back to summary
public static final Scannable.Attr<String> NAME An arbitrary name given to the operator component. Defaults to null.

NULL_SCAN	back to summary
pack-priv static final Scannable NULL_SCAN A constant that represents `Scannable` returned via `from(Object)` when the passed reference is null

PARENT back to summary

PARENT	back to summary
public static final Scannable.Attr<Scannable> PARENT Parent key exposes the direct upstream relationship of the scanned component. It can be a Publisher source to an operator, a Subscription to a Subscriber (main flow if ambiguous with inner Subscriptions like flatMap), a Scheduler to a Worker. These types are not always `Scannable`, but this attribute will convert such raw results to an `unavailable scan` object in this case. `Scannable#parents()` can be used to navigate the parent chain.

public static final Scannable.Attr<Scannable> PARENT

Parent key exposes the direct upstream relationship of the scanned component. It can be a Publisher source to an operator, a Subscription to a Subscriber (main flow if ambiguous with inner Subscriptions like flatMap), a Scheduler to a Worker. These types are not always Scannable, but this attribute will convert such raw results to an unavailable scan object in this case.

Scannable#parents() can be used to navigate the parent chain.

PREFETCH back to summary

PREFETCH	back to summary
public static final Scannable.Attr<Integer> PREFETCH Prefetch is an `Integer` attribute defining the rate of processing in a component which has capacity to request and hold a backlog of data. It usually maps to a component capacity when no arbitrary `CAPACITY` is set. `Integer#MAX_VALUE` signal unlimited capacity and therefore unbounded demand. Note This attribute usually resolves to a constant value.

public static final Scannable.Attr<Integer> PREFETCH

Prefetch is an Integer attribute defining the rate of processing in a component which has capacity to request and hold a backlog of data. It usually maps to a component capacity when no arbitrary CAPACITY is set. Integer#MAX_VALUE signal unlimited capacity and therefore unbounded demand.

Note

This attribute usually resolves to a constant value.

REQUESTED_FROM_DOWNSTREAM	back to summary
public static final Scannable.Attr<Long> REQUESTED_FROM_DOWNSTREAM A `Long` attribute exposing the current pending demand of a downstream component. Note that `Long#MAX_VALUE` indicates an unbounded (push-style) demand as specified in `org.reactivestreams.Subscription#request(long)`.

RUN_ON	back to summary
public static final Scannable.Attr<Scannable> RUN_ON A key that links a `Scannable` to another `Scannable` it runs on. Usually exposes a link between an operator/subscriber and its `Worker` or `Scheduler`, provided these are `Scannable`. Will return `Attr#UNAVAILABLE_SCAN` if the supporting execution is not Scannable or `Attr#NULL_SCAN` if the operator doesn't define a specific runtime.

RUN_STYLE	back to summary
public static final Scannable.Attr<Scannable.Attr.RunStyle> RUN_STYLE An `RunStyle` enum attribute indicating whether or not an operator continues to operate on the same thread. Each value provides a different degree of guarantee from weakest `RunStyle#UNKNOWN` to strongest `RunStyle#SYNC`. Defaults to `RunStyle#UNKNOWN`.

safeConverter	back to summary
pack-priv final Function<Object, ? extends T> safeConverter

TAGS	back to summary
public static final Scannable.Attr<Stream<Tuple2<String, String>>> TAGS A `Stream` of `reactor.util.function.Tuple2` representing key/value pairs for tagged components. Defaults to null.

TERMINATED	back to summary
public static final Scannable.Attr<Boolean> TERMINATED A `Boolean` attribute indicating whether or not an upstream component terminated this scanned component. e.g. a post onComplete/onError subscriber. By opposition to `CANCELLED` which determines if a downstream component interrupted this scanned component.

UNAVAILABLE_SCAN	back to summary
pack-priv static final Scannable UNAVAILABLE_SCAN A constant that represents `Scannable` returned via `from(Object)` when the passed non-null reference is not a `Scannable`

Constructor Detail

Attr	back to summary
protected Attr(T defaultValue)

Attr	back to summary
protected Attr(T defaultValue, Function<Object, ? extends T> safeConverter)

Method Detail

defaultValue	back to summary
public T defaultValue() Meaningful and always applicable default value for the attribute, returned instead of null when a specific value hasn't been defined for a component. null if no sensible generic default is available. Returns:T the default value applicable to all components or null if none. Annotations @Nullable

defaultValue

back to summary

public T defaultValue()

Meaningful and always applicable default value for the attribute, returned instead of null when a specific value hasn't been defined for a component. null if no sensible generic default is available.

Returns:T

the default value applicable to all components or null if none.

Annotations

@Nullable

isConversionSafe back to summary

isConversionSafe	back to summary
pack-priv boolean isConversionSafe() Checks if this attribute is capable of safely converting any Object into a `T` via `tryConvert(Object)` (potentially returning `null` or a Null Object for incompatible raw values). Returns:boolean true if the attribute can safely convert any object, false if it can throw `ClassCastException`

pack-priv boolean isConversionSafe()

Checks if this attribute is capable of safely converting any Object into a T via tryConvert(Object) (potentially returning null or a Null Object for incompatible raw values).

Returns:boolean: true if the attribute can safely convert any object, false if it can throw ClassCastException

recurse	back to summary
pack-priv static Stream<? extends Scannable> recurse(Scannable _s, Scannable.Attr<Scannable> key)

tryConvert back to summary

tryConvert	back to summary
pack-priv T tryConvert(Object o) Attempt to convert any `Object` instance o into a `T`. By default unsafe attributes will just try forcing a cast, which can lead to `ClassCastException`. However, attributes for which `isConversionSafe()` returns true are required to not throw an exception (but rather return `null` or a Null Object). Parameters o:Object the instance to attempt conversion on Returns:T the converted instance Annotations @Nullable

pack-priv T tryConvert(Object o)

Attempt to convert any Object instance o into a T. By default unsafe attributes will just try forcing a cast, which can lead to ClassCastException. However, attributes for which isConversionSafe() returns true are required to not throw an exception (but rather return null or a Null Object).

Parameters

o:Object: the instance to attempt conversion on

Returns:T

the converted instance

Annotations

@Nullable

reactor.core back to summary

public final Enum Scannable.Attr.RunStyle

Class Inheritance

extends Enum<Scannable.Attr.RunStyle>

java.lang.Object
java.lang.Enum
reactor.core.Scannable.Attr.RunStyle

An Enum enumerating the different styles an operator can run : their ordinal() reflects the level of confidence in their running mode

Field Summary

Modifier and Type	Field and Description
public static final Scannable.Attr.RunStyle	ASYNC the operator may change threads while running
public static final Scannable.Attr.RunStyle	SYNC guarantees the operator doesn't change threads (strongest level of guarantee)
public static final Scannable.Attr.RunStyle	UNKNOWN no guarantees can be given on the running mode (default value, weakest level of guarantee)

Constructor Summary

Access	Constructor and Description
private	RunStyle()

Method Summary

Modifier and Type	Method and Description
public static Scannable.Attr.RunStyle	valueOf(String name)
public static Scannable.Attr.RunStyle[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ASYNC	back to summary
public static final Scannable.Attr.RunStyle ASYNC the operator may change threads while running

SYNC	back to summary
public static final Scannable.Attr.RunStyle SYNC guarantees the operator doesn't change threads (strongest level of guarantee)

UNKNOWN	back to summary
public static final Scannable.Attr.RunStyle UNKNOWN no guarantees can be given on the running mode (default value, weakest level of guarantee)

Constructor Detail

RunStyle	back to summary
private RunStyle()

Method Detail

valueOf	back to summary
public static Scannable.Attr.RunStyle valueOf(String name)

values	back to summary
public static Scannable.Attr.RunStyle[] values()

public Interface Scannable

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class Scannable.Attr<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Scannable.Attr.RunStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail