org.apache.jackrabbit.oak.segment

Class SegmentWriterBuilder

java.lang.Object

org.apache.jackrabbit.oak.segment.SegmentWriterBuilder

public final class SegmentWriterBuilder
extends Object

Builder for building SegmentWriter instances. The returned instances are thread safe if withWriterPool() was specified and not thread sage 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 and Description
SegmentWriter	build(FileStore store) Build a SegmentWriter for a FileStore.
SegmentWriter	build(MemoryStore store) Build a SegmentWriter for a MemoryStore.
SegmentWriter	build(ReadOnlyFileStore store) Build a SegmentWriter for a ReadOnlyFileStore.
static SegmentWriterBuilder	segmentWriterBuilder(String name) Set the name of this builder.
SegmentWriterBuilder	with(WriterCacheManager cacheManager) Specify the cacheManager used by the returned writer.
SegmentWriterBuilder	withGeneration(int generation) Specify the generation for the segment written by the returned segment writer.
SegmentWriterBuilder	withGeneration(com.google.common.base.Supplier<Integer> generation) Specify the generation for the segment written by the returned segment writer.
SegmentWriterBuilder	withoutCache() Specify that the returned writer should not use a cache.
SegmentWriterBuilder	withoutWriterPool() Create a SegmentWriter backed by a SegmentBufferWriter.
SegmentWriterBuilder	withWriterPool() 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

segmentWriterBuilder

@Nonnull
public static SegmentWriterBuilder segmentWriterBuilder(@Nonnull
                                                                 String name)

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

withGeneration

@Nonnull
public SegmentWriterBuilder withGeneration(@Nonnull
                                                    com.google.common.base.Supplier<Integer> 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() was specified a segments will be written at the generation that generation.get() returns when a new segment is created by the returned writer.

withGeneration

@Nonnull
public SegmentWriterBuilder withGeneration(int generation)

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

withWriterPool

@Nonnull
public SegmentWriterBuilder withWriterPool()

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

withoutWriterPool

@Nonnull
public SegmentWriterBuilder withoutWriterPool()

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

with

@Nonnull
public SegmentWriterBuilder with(WriterCacheManager cacheManager)

Specify the cacheManager used by the returned writer.

withoutCache

@Nonnull
public SegmentWriterBuilder withoutCache()

Specify that the returned writer should not use a cache.

See Also:

with(WriterCacheManager)

build

@Nonnull
public SegmentWriter build(@Nonnull
                                    FileStore store)

Build a SegmentWriter for a FileStore.

build

@Nonnull
public SegmentWriter build(@Nonnull
                                    ReadOnlyFileStore store)

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

build

@Nonnull
public SegmentWriter build(@Nonnull
                                    MemoryStore store)

Build a SegmentWriter for a MemoryStore.