org.janelia.saalfeldlab.n5.universe.options

Class N5FactoryOptions

java.lang.Object

org.janelia.saalfeldlab.n5.universe.options.N5FactoryOptions

public class N5FactoryOptions
extends Object

Constructor Summary

Constructors

Constructor and Description
N5FactoryOptions()

Method Summary

Modifier and Type	Method and Description
N5FactoryOptions	cacheAttributes(boolean cacheAttributes) Set the attributes caching behavior.
HDF5Builder	getHdf5Builder()
N5Builder	getN5Builder()
Zarr2Builder	getZarr2Builder()
Zarr3Builder	getZarr3Builder()
N5FactoryOptions	gsonBuilder(com.google.gson.GsonBuilder gsonBuilder) Set the default GsonBuilder.
N5FactoryOptions	hdf5(Consumer<HDF5Builder> configure) Configure HDF5Builder to be used when the factory accesses an HDF5 container.
N5FactoryOptions	n5(Consumer<N5Builder> configure) Configure N5Builder to be used when the factory accesses an N5 container.
N5FactoryOptions	zarr2(Consumer<Zarr2Builder> configure) Configure Zarr2Builder to be used when the factory accesses a Zarr2 container.
N5FactoryOptions	zarr3(Consumer<Zarr3Builder> configure) Configure Zarr3Builder to be used when the factory accesses a Zarr3 container.

Methods inherited from class java.lang.Object

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

Constructor Detail

N5FactoryOptions

public N5FactoryOptions()

Method Detail

n5

public N5FactoryOptions n5(Consumer<N5Builder> configure)

Configure N5Builder to be used when the factory accesses an N5 container.

Parameters:

configure - a Consumer<N5Builder> and performs custom configuration on it

Returns:

the current instance of N5FactoryOptions

hdf5

public N5FactoryOptions hdf5(Consumer<HDF5Builder> configure)

Configure HDF5Builder to be used when the factory accesses an HDF5 container.

Parameters:

configure - a Consumer<HDF5Builder> and performs custom configuration on it

Returns:

the current instance of N5FactoryOptions

zarr2

public N5FactoryOptions zarr2(Consumer<Zarr2Builder> configure)

Configure Zarr2Builder to be used when the factory accesses a Zarr2 container.

Parameters:

configure - a Consumer<Zarr2Builder> and performs custom configuration on it

Returns:

the current instance of N5FactoryOptions

zarr3

public N5FactoryOptions zarr3(Consumer<Zarr3Builder> configure)

Configure Zarr3Builder to be used when the factory accesses a Zarr3 container.

Parameters:

configure - a Consumer<Zarr3Builder> and performs custom configuration on it

Returns:

the current instance of N5FactoryOptions

cacheAttributes

public N5FactoryOptions cacheAttributes(boolean cacheAttributes)

Set the attributes caching behavior. Will be overridden by any format-specific configurations

Parameters:

cacheAttributes - flag to use for otherwise unconfigured N5Readers

Returns:

this

gsonBuilder

public N5FactoryOptions gsonBuilder(com.google.gson.GsonBuilder gsonBuilder)

Set the default GsonBuilder. Will be overridden by any format-specific configurations

Parameters:

gsonBuilder - to use for otherwise unconfigured N5Readers

Returns:

this

getN5Builder

public N5Builder getN5Builder()

getHdf5Builder

public HDF5Builder getHdf5Builder()

getZarr2Builder

public Zarr2Builder getZarr2Builder()

getZarr3Builder

public Zarr3Builder getZarr3Builder()