net.openhft.chronicle.wire.domestic.extractor

Interface ToLongDocumentExtractor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ToLongDocumentExtractor

Method Summary

Modifier and Type	Method and Description
long	extractAsLong(@NotNull Wire wire, long index) Extracts a value of type long from the provided wire and index or else Long.MIN_VALUE if no value can be extracted.
static ToLongDocumentExtractor	extractingIndex()
default ToLongDocumentExtractor	filter(@NotNull LongPredicate predicate) Creates and returns a new ToLongDocumentExtractor consisting of the elements of this ToLongDocumentExtractor that match the provided predicate.
default ToLongDocumentExtractor	map(@NotNull LongUnaryOperator mapper) Creates and returns a new ToLongDocumentExtractor consisting of the results (of type R) of applying the provided mapper to the elements of this ToLongDocumentExtractor.
default ToDoubleDocumentExtractor	mapToDouble(@NotNull LongToDoubleFunction mapper) Creates and returns a new ToDoubleDocumentExtractor consisting of applying the provided mapper to the elements of this ToLongDocumentExtractor.
default <T> DocumentExtractor<T>	mapToObj(@NotNull LongFunction<? extends T> mapper) Creates and returns a new DocumentExtractor consisting of applying the provided mapper to the elements of this ToLongDocumentExtractor.

Method Detail

extractAsLong

long extractAsLong(@NotNull
                   @NotNull Wire wire,
                   long index)

Extracts a value of type long from the provided wire and index or else Long.MIN_VALUE if no value can be extracted.

Long.MIN_VALUE may be returned if the queue was written with a method writer and there are messages in the queue but of another type.

Extractors that must include Long.MIN_VALUE as a valid value must use other means of aggregating values (e.g. use an DocumentExtractor .

Parameters:

wire - to use

index - to use

Returns:

extracted value or Long.MIN_VALUE

map

default ToLongDocumentExtractor map(@NotNull
                                    @NotNull LongUnaryOperator mapper)

Creates and returns a new ToLongDocumentExtractor consisting of the results (of type R) of applying the provided mapper to the elements of this ToLongDocumentExtractor.

Values mapped to Long.MIN_VALUE are removed.

Parameters:

mapper - to apply

Returns:

a new mapped ToLongDocumentExtractor

Throws:

NullPointerException - if the provided mapper is null

mapToObj

default <T> DocumentExtractor<T> mapToObj(@NotNull
                                          @NotNull LongFunction<? extends T> mapper)

Creates and returns a new DocumentExtractor consisting of applying the provided mapper to the elements of this ToLongDocumentExtractor.

Values mapped to Long.MIN_VALUE are removed.

Parameters:

mapper - to apply

Returns:

a new mapped DocumentExtractor

Throws:

NullPointerException - if the provided mapper is null

mapToDouble

default ToDoubleDocumentExtractor mapToDouble(@NotNull
                                              @NotNull LongToDoubleFunction mapper)

Creates and returns a new ToDoubleDocumentExtractor consisting of applying the provided mapper to the elements of this ToLongDocumentExtractor.

Values mapped to Long.MIN_VALUE are removed.

Parameters:

mapper - to apply

Returns:

a new mapped ToDoubleDocumentExtractor

Throws:

NullPointerException - if the provided mapper is null

filter

default ToLongDocumentExtractor filter(@NotNull
                                       @NotNull LongPredicate predicate)

Creates and returns a new ToLongDocumentExtractor consisting of the elements of this ToLongDocumentExtractor that match the provided predicate.

Parameters:

predicate - to apply to each element to determine if it should be included

Returns:

a ToLongDocumentExtractor consisting of the elements of this ToLongDocumentExtractor that match

Throws:

NullPointerException - if the provided predicate is null

extractingIndex

static ToLongDocumentExtractor extractingIndex()