Class DittoConfig

java.lang.Object

com.ditto.java.DittoConfig

public final class DittoConfig
extends Object

Configuration for creating a Ditto instance. Use DittoConfig.Builder to construct instances of this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DittoConfig.Builder	Builder for creating DittoConfig instances.
static class	DittoConfig.Connect	Defines how Ditto should connect to other peers.
static final class	DittoConfig.Experimental	Experimental features configuration for Ditto.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@NonNull DittoConfig.Connect	getConnect()	Returns the connection configuration.
@NonNull String	getDatabaseId()	Returns the database ID for this configuration.
static @NonNull DittoConfig	getDefault()	Returns the default DittoConfig instance.
static @NonNull String	getDefaultDatabaseId()	Returns the default database ID.
@NonNull DittoConfig.Experimental	getExperimental()	Returns the experimental features configuration.
@Nullable File	getPersistenceDirectory()	Returns the persistence directory as a File object.
@Nullable String	getPersistenceDirectoryPath()	Returns the persistence directory path as a string.
int	hashCode()
String	toString()
@NonNull DittoConfig	withConnect(@NonNull DittoConfig.Connect connect)	Creates a new DittoConfig with a different connection configuration.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getDatabaseId

public @NonNull String getDatabaseId()

Returns the database ID for this configuration.

Returns:

the database ID string.

getConnect

public @NonNull DittoConfig.Connect getConnect()

Returns the connection configuration.

Returns:

the DittoConfig.Connect configuration specifying how Ditto connects to other peers.

getPersistenceDirectory

public @Nullable File getPersistenceDirectory()

Returns the persistence directory as a File object.

Returns:

the persistence directory File, or null if using the default directory.

getPersistenceDirectoryPath

public @Nullable String getPersistenceDirectoryPath()

Returns the persistence directory path as a string.

Returns:

the persistence directory path, or null if using the default directory.

getExperimental

public @NonNull DittoConfig.Experimental getExperimental()

Returns the experimental features configuration.

Returns:

the DittoConfig.Experimental configuration.

withConnect

public @NonNull DittoConfig withConnect(@NonNull DittoConfig.Connect connect)

Creates a new DittoConfig with a different connection configuration.

Parameters:

connect - the new DittoConfig.Connect configuration.

Returns:

a new DittoConfig instance with the updated connection settings.

getDefault

public static @NonNull DittoConfig getDefault()

Returns the default DittoConfig instance.

Returns:

a default configuration suitable for most use cases.

getDefaultDatabaseId

public static @NonNull String getDefaultDatabaseId()

Returns the default database ID.

Returns:

the default database ID string.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object