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 java.lang.Object

Builder for creating FileStore instances.

Method Summary

Modifier and Type	Method and Description
FileStore	create() /** Create a new FileStore instance with the settings specified in this builder.
FileStore.Builder	withBlobStore(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(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(NodeState root) Specify the initial root node state for the file store
FileStore.Builder	withStatisticsProvider(StatisticsProvider statisticsProvider) StatisticsProvider for collecting statistics related to FileStore

Methods inherited from class java.lang.Object

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

Method Detail

withBlobStore

public FileStore.Builder withBlobStore(BlobStore blobStore)

Specify the BlobStore.

Parameters:

blobStore -

Returns:

this instance

withRoot

public FileStore.Builder withRoot(NodeState root)

Specify the initial root node state for the file store

Parameters:

root -

Returns:

this instance

withMaxFileSize

public FileStore.Builder withMaxFileSize(int maxFileSize)

Maximal size of the generated tar files in MB.

Parameters:

maxFileSize -

Returns:

this instance

withCacheSize

public FileStore.Builder withCacheSize(int cacheSize)

Size of the cache in MB.

Parameters:

cacheSize -

Returns:

this instance

withNoCache

public FileStore.Builder withNoCache()

Turn caching off

Returns:

this instance

withMemoryMapping

public FileStore.Builder withMemoryMapping(boolean memoryMapping)

Turn memory mapping on or off

Parameters:

memoryMapping -

Returns:

this instance

withDefaultMemoryMapping

public FileStore.Builder withDefaultMemoryMapping()

Set memory mapping to the default value based on OS properties

Returns:

this instance

withGCMonitor

public FileStore.Builder withGCMonitor(GCMonitor gcMonitor)

GCMonitor for monitoring this files store's gc process.

Parameters:

gcMonitor -

Returns:

this instance

withStatisticsProvider

public FileStore.Builder withStatisticsProvider(StatisticsProvider statisticsProvider)

StatisticsProvider for collecting statistics related to FileStore

Parameters:

statisticsProvider -

Returns:

this instance

create

public FileStore create()
                 throws java.io.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:

java.io.IOException