net.openhft.chronicle.wire.internal.reduction

Class ReductionUtil.CollectorReduction<E,A,R>

java.lang.Object

net.openhft.chronicle.wire.internal.reduction.ReductionUtil.CollectorReduction<E,A,R>

All Implemented Interfaces:

Reduction<R>, ExcerptListener

Enclosing class:

ReductionUtil

public static final class ReductionUtil.CollectorReduction<E,A,R>
extends Object
implements Reduction<R>

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.domestic.reduction.Reduction

Reduction.DoubleReductionBuilder, Reduction.LongReductionBuilder, Reduction.ReductionBuilder<E>

Constructor Summary

Constructors

Constructor and Description
CollectorReduction(@NotNull DocumentExtractor<E> extractor, @NotNull Collector<E,A,? extends R> collector)

Method Summary

Modifier and Type	Method and Description
long	accept(@NotNull MarshallableIn tailer) Accepts the input of the provided tailer and reduces (folds) the contents of it into this Reduction returning the last seen index or -1 if no index was seen.
void	onExcerpt(@NotNull Wire wire, long index) Consumes an excerpt from the provided wire at the index at the provided index.
R	reduction() Returns a view of the underlying reduction.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.wire.domestic.reduction.Reduction

of, ofDouble, ofLong

Methods inherited from interface net.openhft.chronicle.wire.ExcerptListener

andThen

Constructor Detail

CollectorReduction

public CollectorReduction(@NotNull
                          @NotNull DocumentExtractor<E> extractor,
                          @NotNull
                          @NotNull Collector<E,A,? extends R> collector)

Method Detail

onExcerpt

public void onExcerpt(@NotNull
                      @NotNull Wire wire,
                      long index)
               throws net.openhft.chronicle.core.io.InvalidMarshallableException

Description copied from interface: Reduction

Consumes an excerpt from the provided wire at the index at the provided index.

If this method throws an Exception, it is relayed to the call site. Therefore, care should be taken to minimise the probability of throwing Exceptions.

If this method is referenced as an ExcerptListener then the Reduction must be thread-safe.

Specified by:

onExcerpt in interface Reduction<R>

Specified by:

onExcerpt in interface ExcerptListener

Parameters:

wire - representing access to the excerpt that was stored (non-null).

index - in the queue where the except was placed (non-negative)

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

reduction

@NotNull
public R reduction()

Description copied from interface: Reduction

Returns a view of the underlying reduction.

Specified by:

reduction in interface Reduction<R>

Returns:

Reduction view.

accept

public long accept(@NotNull
                   @NotNull MarshallableIn tailer)
            throws net.openhft.chronicle.core.io.InvalidMarshallableException

Description copied from interface: Reduction

Accepts the input of the provided tailer and reduces (folds) the contents of it into this Reduction returning the last seen index or -1 if no index was seen.

This method can be used to initialise a Reduction before appending new values.

It is the responsibility of the caller to make sure no simultaneous appenders are using this Reduction during the entire fold operation.

Specified by:

accept in interface Reduction<R>

Parameters:

tailer - to reduce (fold) from

Returns:

the last index seen or -1 if no index was seen

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException