Package org.apache.jackrabbit.oak.segment

Class DefaultSegmentWriterBuilder

java.lang.Object

org.apache.jackrabbit.oak.segment.DefaultSegmentWriterBuilder

public final class DefaultSegmentWriterBuilder
extends java.lang.Object

Builder for building DefaultSegmentWriter instances. The returned instances are thread-safe if withWriterPool(PoolType) was specified and not thread-safe if withoutWriterPool() was specified (default).

Default: calling one of the build() methods without previously calling one of the with...() methods returns a SegmentWriter as would the following chain of calls:

     segmentWriterBuilder("name")
        .with(LATEST_VERSION)
        .withGeneration(0)
        .withoutWriterPool()
        .with(new WriterCacheManager.Default())
        .build(store);
 

Method Summary

Modifier and Type	Method	Description
@NotNull DefaultSegmentWriter	build(@NotNull FileStore store)	Build a SegmentWriter for a FileStore.
@NotNull DefaultSegmentWriter	build(@NotNull ReadOnlyFileStore store)	Build a SegmentWriter for a ReadOnlyFileStore.
@NotNull DefaultSegmentWriter	build(@NotNull MemoryStore store)	Build a SegmentWriter for a MemoryStore.
static @NotNull DefaultSegmentWriterBuilder	defaultSegmentWriterBuilder(@NotNull java.lang.String name)	Set the name of this builder.
@NotNull DefaultSegmentWriterBuilder	with(WriterCacheManager cacheManager)	Specify the cacheManager used by the returned writer.
@NotNull DefaultSegmentWriterBuilder	withGeneration(@NotNull org.apache.jackrabbit.guava.common.base.Supplier<GCGeneration> generation)	Specify the generation for the segment written by the returned segment writer.
@NotNull DefaultSegmentWriterBuilder	withGeneration(@NotNull GCGeneration generation)	Specify the generation for the segment written by the returned segment writer.
@NotNull DefaultSegmentWriterBuilder	withoutCache()	Specify that the returned writer should not use a cache.
@NotNull DefaultSegmentWriterBuilder	withoutWriterPool()	Create a SegmentWriter backed by a SegmentBufferWriter.
@NotNull DefaultSegmentWriterBuilder	withWriterPool()
@NotNull DefaultSegmentWriterBuilder	withWriterPool(SegmentBufferWriterPool.PoolType writerType)	Create a SegmentWriter backed by a SegmentBufferWriterPool.

Methods inherited from class java.lang.Object

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

Method Detail

defaultSegmentWriterBuilder

@NotNull
public static @NotNull DefaultSegmentWriterBuilder defaultSegmentWriterBuilder(@NotNull
                                                                               @NotNull java.lang.String name)

Set the name of this builder. This name will appear in the segment's meta data.

withGeneration

@NotNull
public @NotNull DefaultSegmentWriterBuilder withGeneration(@NotNull
                                                           @NotNull org.apache.jackrabbit.guava.common.base.Supplier<GCGeneration> generation)

Specify the generation for the segment written by the returned segment writer.

If withoutWriterPool() was specified all segments will be written at the generation that generation.get() returned at the time any of the build() methods is called. If withWriterPool(PoolType) ()} was specified, segments will be written at the generation that generation.get() returns when a new segment is created by the returned writer.

withGeneration

@NotNull
public @NotNull DefaultSegmentWriterBuilder withGeneration(@NotNull
                                                           @NotNull GCGeneration generation)

Specify the generation for the segment written by the returned segment writer.

withWriterPool

@NotNull
public @NotNull DefaultSegmentWriterBuilder withWriterPool()

withWriterPool

@NotNull
public @NotNull DefaultSegmentWriterBuilder withWriterPool(SegmentBufferWriterPool.PoolType writerType)

Create a SegmentWriter backed by a SegmentBufferWriterPool. The returned instance is thread safe.

withoutWriterPool

@NotNull
public @NotNull DefaultSegmentWriterBuilder withoutWriterPool()

Create a SegmentWriter backed by a SegmentBufferWriter. The returned instance is not thread safe.

with

@NotNull
public @NotNull DefaultSegmentWriterBuilder with(WriterCacheManager cacheManager)

Specify the cacheManager used by the returned writer.

withoutCache

@NotNull
public @NotNull DefaultSegmentWriterBuilder withoutCache()

Specify that the returned writer should not use a cache.

See Also:

with(WriterCacheManager)

build

@NotNull
public @NotNull DefaultSegmentWriter build(@NotNull
                                           @NotNull FileStore store)

Build a SegmentWriter for a FileStore.

build

@NotNull
public @NotNull DefaultSegmentWriter build(@NotNull
                                           @NotNull ReadOnlyFileStore store)

Build a SegmentWriter for a ReadOnlyFileStore. Attempting to write to the returned writer will cause a UnsupportedOperationException to be thrown.

build

@NotNull
public @NotNull DefaultSegmentWriter build(@NotNull
                                           @NotNull MemoryStore store)

Build a SegmentWriter for a MemoryStore.