net.openhft.chronicle.wire.internal.extractor

Class DocumentExtractorBuilder<E>

java.lang.Object

net.openhft.chronicle.wire.internal.extractor.DocumentExtractorBuilder<E>

All Implemented Interfaces:

net.openhft.chronicle.core.util.Builder<DocumentExtractor<E>>, DocumentExtractor.Builder<E>

public final class DocumentExtractorBuilder<E>
extends Object
implements DocumentExtractor.Builder<E>

Constructor Summary

Constructors

Constructor and Description
DocumentExtractorBuilder(@NotNull Class<E> elementType)

Method Summary

Modifier and Type	Method and Description
@NotNull DocumentExtractor<E>	build()
<I> DocumentExtractor.Builder<E>	withMethod(@NotNull Class<I> interfaceType, @NotNull BiConsumer<? super I,? super E> methodReference) Specifies an interfaceType that was previously used to write messages of type E using a method writer via invocations of the provided methodReference.
DocumentExtractor.Builder<E>	withReusing(@NotNull Supplier<? extends E> supplier) Specifies a supplier of element that shall be reused when extracting elements from excerpts.
DocumentExtractor.Builder<E>	withThreadConfinedReuse() Specifies that only one reuse object, confined to the first using thread, shall be reused.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentExtractorBuilder

public DocumentExtractorBuilder(@NotNull
                                @NotNull Class<E> elementType)

Method Detail

withReusing

@NotNull
public DocumentExtractor.Builder<E> withReusing(@NotNull
                                                         @NotNull Supplier<? extends E> supplier)

Description copied from interface: DocumentExtractor.Builder

Specifies a supplier of element that shall be reused when extracting elements from excerpts.

By default, thread local reuse objects are created on demand but this can be changed by means of the DocumentExtractor.Builder.withThreadConfinedReuse() method.

The provided supplier must provide distinct objects on each invocation. This can be accomplished , for example, by referencing Foo:new.

Specified by:

withReusing in interface DocumentExtractor.Builder<E>

Parameters:

supplier - to call when reuse object are needed (non-null)

Returns:

this Builder

withThreadConfinedReuse

@NotNull
public DocumentExtractor.Builder<E> withThreadConfinedReuse()

Description copied from interface: DocumentExtractor.Builder

Specifies that only one reuse object, confined to the first using thread, shall be reused.

The DocumentExtractor is guaranteed to prevent accidental concurrent thread access by throwing an IllegalStateException if accessed by a foreign thread.

Specified by:

withThreadConfinedReuse in interface DocumentExtractor.Builder<E>

Returns:

this Builder

withMethod

@NotNull
public <I> DocumentExtractor.Builder<E> withMethod(@NotNull
                                                            @NotNull Class<I> interfaceType,
                                                            @NotNull
                                                            @NotNull BiConsumer<? super I,? super E> methodReference)

Description copied from interface: DocumentExtractor.Builder

Specifies an interfaceType that was previously used to write messages of type E using a method writer via invocations of the provided methodReference.

The provided methodReference must be a true method reference (e.g. Greeting:message) or a corresponding lambda expression (e.g. (Greeting greeting, String msg) -> greeting.message(m)) ) or else the result is undefined.

Specified by:

withMethod in interface DocumentExtractor.Builder<E>

Type Parameters:

I - interface type

Parameters:

interfaceType - interface that has at least one method that takes a single argument parameter of type E

methodReference - connecting the interface type to a method that takes a single argument parameter of type E

Returns:

this Builder

build

@NotNull
public @NotNull DocumentExtractor<E> build()

Specified by:

build in interface net.openhft.chronicle.core.util.Builder<DocumentExtractor<E>>