Language

IGatherer Interface

Definition

An intermediate operation that transforms a stream of input elements into a stream of output elements, optionally applying a final action when the end of the upstream is reached.

[Android.Runtime.Register("java/util/stream/Gatherer", "", "Java.Util.Streams.IGathererInvoker", ApiSince=36)]
[Java.Interop.JavaTypeParameters(new System.String[] { "T", "A", "R" })]
public interface IGatherer : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("java/util/stream/Gatherer", "", "Java.Util.Streams.IGathererInvoker", ApiSince=36)>]
[<Java.Interop.JavaTypeParameters(new System.String[] { "T", "A", "R" })>]
type IGatherer = interface
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Derived
Attributes
Implements

Remarks

An intermediate operation that transforms a stream of input elements into a stream of output elements, optionally applying a final action when the end of the upstream is reached. The transformation may be stateless or stateful, and may buffer input before producing any output.

Gatherer operations can be performed either sequentially, or be parallelized -- if a combiner function is supplied.

There are many examples of gathering operations, including but not limited to: grouping elements into batches (windowing functions); de-duplicating consecutively similar elements; incremental accumulation functions (prefix scan); incremental reordering functions, etc. The class java.util.stream.Gatherers provides implementations of common gathering operations.

Added in 24.

Java documentation for java.util.stream.Gatherer.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Properties

Name Description
Handle

Gets the JNI value of the underlying Android object.

(Inherited from IJavaObject)
JniIdentityHashCode

Returns the value of java.lang.System.identityHashCode() for the wrapped instance.

(Inherited from IJavaPeerable)
JniManagedPeerState

State of the managed peer.

(Inherited from IJavaPeerable)
JniObjectReferenceControlBlock

Gets an implementation-specific JNI reference control-block pointer.

(Inherited from IJavaPeerable)
JniPeerMembers

Member access and invocation support.

(Inherited from IJavaPeerable)
PeerReference

Returns a JniObjectReference of the wrapped Java object instance.

(Inherited from IJavaPeerable)

Methods

Name Description
AndThen(IGatherer)

Returns a composed Gatherer which connects the output of this Gatherer to the input of that Gatherer.

Combiner()

A function which accepts two intermediate states and combines them into one.

DefaultCombiner()

Returns a combiner which is the default combiner of a Gatherer.

DefaultFinisher()

Returns a finisher which is the default finisher of a Gatherer.

DefaultInitializer()

Returns an initializer which is the default initializer of a Gatherer.

Disposed()

Called when the instance has been disposed.

(Inherited from IJavaPeerable)
DisposeUnlessReferenced()

If there are no outstanding references to this instance, then calls Dispose(); otherwise, does nothing.

(Inherited from IJavaPeerable)
Finalized()

Called when the instance has been finalized.

(Inherited from IJavaPeerable)
Finisher()

A function which accepts the final intermediate state and a Downstream object, allowing to perform a final action at the end of input elements.

GetIntegrator()

Gets the function that processes each input element.

Initializer()

A function that produces an instance of the intermediate state used for this gathering operation.

Of(IGatherer+IIntegrator, IBiConsumer)

Creates a stateless gatherer with a final action and support for parallel evaluation.

Of(IGatherer+IIntegrator)

Creates a stateless gatherer that supports parallel evaluation.

Of(ISupplier, IGatherer+IIntegrator, IBinaryOperator, IBiConsumer)

Creates a gatherer from its state, integration, combination, and completion functions.

OfSequential(IGatherer+IIntegrator, IBiConsumer)

Creates a stateless sequential gatherer with a final action.

OfSequential(IGatherer+IIntegrator)

Creates a stateless gatherer for sequential evaluation.

OfSequential(ISupplier, IGatherer+IIntegrator, IBiConsumer)

Creates a sequential gatherer with state, integration, and completion functions.

OfSequential(ISupplier, IGatherer+IIntegrator)

Creates a sequential gatherer with the supplied state initializer and integration function.

SetJniIdentityHashCode(Int32)

Set the value returned by JniIdentityHashCode.

(Inherited from IJavaPeerable)
SetJniManagedPeerState(JniManagedPeerStates)

Sets the state flags returned by JniManagedPeerState.

(Inherited from IJavaPeerable)
SetPeerReference(JniObjectReference)

Set the value returned by PeerReference.

(Inherited from IJavaPeerable)
UnregisterFromRuntime()

Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations.

(Inherited from IJavaPeerable)

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)

Reuses a compatible managed peer or obtains a wrapper of the requested type.

TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to