net.openhft.chronicle.wire.domestic.extractor

Interface DocumentExtractor<T>

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 DocumentExtractor<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentExtractor.Builder<E> Generic builder that can be used to build DocumentExtractor objects of common types.

Method Summary

Modifier and Type	Method and Description
static <E> DocumentExtractor.Builder<E>	builder(@NotNull Class<E> elementType) Creates and returns a new Builder that can be used to create DocumentExtractor objects of the provided elementType.
T	extract(@NotNull Wire wire, long index) Extracts a value of type T from the provided wire and index or else null if no value can be extracted.
default DocumentExtractor<T>	filter(@NotNull Predicate<? super T> predicate) Creates and returns a new DocumentExtractor consisting of the elements of this DocumentExtractor that match the provided predicate.
default <R> DocumentExtractor<R>	map(@NotNull Function<? super T,? extends R> mapper) Creates and returns a new DocumentExtractor consisting of the results (of type R) of applying the provided mapper to the elements of this DocumentExtractor.
default ToLongDocumentExtractor	mapToLong(@NotNull ToLongFunction<? super T> mapper) Creates and returns a new ToLongDocumentExtractor consisting of applying the provided mapper to the elements of this DocumentExtractor.

Method Detail

extract

@Nullable
T extract(@NotNull
                    @NotNull Wire wire,
                    long index)
             throws net.openhft.chronicle.core.io.InvalidMarshallableException

Extracts a value of type T from the provided wire and index or else null if no value can be extracted.

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

Parameters:

wire - to use

index - to use

Returns:

extracted value or null

Throws:

net.openhft.chronicle.core.io.InvalidMarshallableException

map

default <R> DocumentExtractor<R> map(@NotNull
                                     @NotNull Function<? super T,? extends R> mapper)

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

Values mapped to null are removed.

Type Parameters:

R - type to map to

Parameters:

mapper - to apply

Returns:

a new mapped DocumentExtractor

Throws:

NullPointerException - if the provided mapper is null

mapToLong

default ToLongDocumentExtractor mapToLong(@NotNull
                                          @NotNull ToLongFunction<? super T> mapper)

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

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

filter

default DocumentExtractor<T> filter(@NotNull
                                    @NotNull Predicate<? super T> predicate)

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

Parameters:

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

Returns:

a DocumentExtractor consisting of the elements of this DocumentExtractor that match

Throws:

NullPointerException - if the provided predicate is null

builder

static <E> DocumentExtractor.Builder<E> builder(@NotNull
                                                @NotNull Class<E> elementType)

Creates and returns a new Builder that can be used to create DocumentExtractor objects of the provided elementType.

Type Parameters:

E - element type

Parameters:

elementType - type of element to extract

Returns:

a new Builder