net.openhft.chronicle.wire.domestic.extractor

Interface ToDoubleDocumentExtractor

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 ToDoubleDocumentExtractor

Method Summary

Modifier and Type	Method and Description
double	extractAsDouble(@NotNull Wire wire, long index) Extracts a value of type double from the provided wire and index or else Double.NaN if no value can be extracted.
default ToDoubleDocumentExtractor	filter(@NotNull DoublePredicate predicate) Creates and returns a new ToDoubleDocumentExtractor consisting of the elements of this ToDoubleDocumentExtractor that match the provided predicate.
default ToDoubleDocumentExtractor	map(@NotNull DoubleUnaryOperator mapper) Creates and returns a new ToDoubleDocumentExtractor consisting of the results (of type R) of applying the provided mapper to the elements of this ToDoubleDocumentExtractor.
default ToLongDocumentExtractor	mapToLong(@NotNull DoubleToLongFunction mapper) Creates and returns a new ToLongDocumentExtractor consisting of applying the provided mapper to the elements of this ToDoubleDocumentExtractor.
default <T> DocumentExtractor<T>	mapToObj(@NotNull DoubleFunction<? extends T> mapper) Creates and returns a new DocumentExtractor consisting of applying the provided mapper to the elements of this DocumentExtractor.

Method Detail

extractAsDouble

double extractAsDouble(@NotNull
                       @NotNull Wire wire,
                       long index)

Extracts a value of type double from the provided wire and index or else Double.NaN if no value can be extracted.

Double.NaN 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 Double.NaN 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 Double.NaN

map

default ToDoubleDocumentExtractor map(@NotNull
                                      @NotNull DoubleUnaryOperator mapper)

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

Values mapped to Double.NaN are removed.

Parameters:

mapper - to apply

Returns:

a new mapped ToDoubleDocumentExtractor

Throws:

NullPointerException - if the provided mapper is null

mapToObj

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

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

Values mapped to Double.NaN are removed.

Parameters:

mapper - to apply

Returns:

a new mapped DocumentExtractor

Throws:

NullPointerException - if the provided mapper is null

mapToLong

default ToLongDocumentExtractor mapToLong(@NotNull
                                          @NotNull DoubleToLongFunction mapper)

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

Values mapped to Double.NaN are removed.

Parameters:

mapper - to apply

Returns:

a new mapped ToLongDocumentExtractor

Throws:

NullPointerException - if the provided mapper is null

filter

default ToDoubleDocumentExtractor filter(@NotNull
                                         @NotNull DoublePredicate predicate)

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

Parameters:

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

Returns:

a ToDoubleDocumentExtractor consisting of the elements of this ToDoubleDocumentExtractor that match

Throws:

NullPointerException - if the provided predicate is null