org.apache.jackrabbit.oak.plugins.segment.file

Class FileStore.Builder

java.lang.Object

org.apache.jackrabbit.oak.plugins.segment.file.FileStore.Builder

Enclosing class:

FileStore

public static class FileStore.Builder
extends Object

Builder for creating FileStore instances.

Method Summary

Methods

Modifier and Type	Method and Description
FileStore	create() /** Create a new FileStore instance with the settings specified in this builder.
FileStore.Builder	withBlobStore(org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore) Specify the BlobStore.
FileStore.Builder	withCacheSize(int cacheSize) Size of the cache in MB.
FileStore.Builder	withDefaultMemoryMapping() Set memory mapping to the default value based on OS properties
FileStore.Builder	withGCMonitor(org.apache.jackrabbit.oak.spi.gc.GCMonitor gcMonitor) GCMonitor for monitoring this files store's gc process.
FileStore.Builder	withMaxFileSize(int maxFileSize) Maximal size of the generated tar files in MB.
FileStore.Builder	withMemoryMapping(boolean memoryMapping) Turn memory mapping on or off
FileStore.Builder	withNoCache() Turn caching off
FileStore.Builder	withRoot(org.apache.jackrabbit.oak.spi.state.NodeState root) Specify the initial root node state for the file store
FileStore.Builder	withStatisticsProvider(org.apache.jackrabbit.oak.stats.StatisticsProvider statisticsProvider) StatisticsProvider for collecting statistics related to FileStore

Methods inherited from class java.lang.Object

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

Method Detail

withBlobStore

@Nonnull
public FileStore.Builder withBlobStore(@Nonnull
                                      org.apache.jackrabbit.oak.spi.blob.BlobStore blobStore)

Specify the BlobStore.

Parameters:

blobStore -

Returns:

this instance

withRoot

@Nonnull
public FileStore.Builder withRoot(@Nonnull
                                 org.apache.jackrabbit.oak.spi.state.NodeState root)

Specify the initial root node state for the file store

Parameters:

root -

Returns:

this instance

withMaxFileSize

@Nonnull
public FileStore.Builder withMaxFileSize(int maxFileSize)

Maximal size of the generated tar files in MB.

Parameters:

maxFileSize -

Returns:

this instance

withCacheSize

@Nonnull
public FileStore.Builder withCacheSize(int cacheSize)

Size of the cache in MB.

Parameters:

cacheSize -

Returns:

this instance

withNoCache

@Nonnull
public FileStore.Builder withNoCache()

Turn caching off

Returns:

this instance

withMemoryMapping

@Nonnull
public FileStore.Builder withMemoryMapping(boolean memoryMapping)

Turn memory mapping on or off

Parameters:

memoryMapping -

Returns:

this instance

withDefaultMemoryMapping

@Nonnull
public FileStore.Builder withDefaultMemoryMapping()

Set memory mapping to the default value based on OS properties

Returns:

this instance

withGCMonitor

@Nonnull
public FileStore.Builder withGCMonitor(@Nonnull
                                      org.apache.jackrabbit.oak.spi.gc.GCMonitor gcMonitor)

GCMonitor for monitoring this files store's gc process.

Parameters:

gcMonitor -

Returns:

this instance

withStatisticsProvider

@Nonnull
public FileStore.Builder withStatisticsProvider(@Nonnull
                                               org.apache.jackrabbit.oak.stats.StatisticsProvider statisticsProvider)

StatisticsProvider for collecting statistics related to FileStore

Parameters:

statisticsProvider -

Returns:

this instance

create

@Nonnull
public FileStore create()
                 throws IOException

/** Create a new FileStore instance with the settings specified in this builder. If none of the with methods have been called before calling this method, a file store with the following default settings is returned:

• blob store: inline
• root: empty node
• max file size: 256MB
• cache size: 256MB
• memory mapping: on for 64 bit JVMs off otherwise
• whiteboard: none. No GCMonitor tracking
• statsProvider: StatisticsProvider.NOOP

Returns:

a new file store instance

Throws:

IOException