com.couchbase.lite

Class DatabaseConfiguration

java.lang.Object

com.couchbase.lite.DatabaseConfiguration

public final class DatabaseConfiguration
extends Object

Options for opening a database. All properties default to false or null.

Constructor Summary

Constructors

Constructor and Description
DatabaseConfiguration() Constructs a new DatabaseConfiguration with default values.
DatabaseConfiguration(File directory, Object encryptionKey, ConflictResolver conflictResolver)

Method Summary

Modifier and Type	Method and Description
ConflictResolver	getConflictResolver()
File	getDirectory() Returns the path to the directory to store the database in.
Object	getEncryptionKey() Returns a key to encrypt the database with.
void	setConflictResolver(ConflictResolver conflictResolver)
void	setDirectory(File directory) Set the path to the directory to store the database in.
void	setEncryptionKey(Object encryptionKey) Set a key to encrypt the database with.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseConfiguration

public DatabaseConfiguration()

Constructs a new DatabaseConfiguration with default values.

DatabaseConfiguration

public DatabaseConfiguration(File directory,
                             Object encryptionKey,
                             ConflictResolver conflictResolver)

Method Detail

getDirectory

public File getDirectory()

Returns the path to the directory to store the database in.

Returns:

the directory

setDirectory

public void setDirectory(File directory)

Set the path to the directory to store the database in. If the directory doesn't already exist it willbe created when the database is opened.

Parameters:

directory - the directory

getEncryptionKey

public Object getEncryptionKey()

Returns a key to encrypt the database with.

Returns:

the key

setEncryptionKey

public void setEncryptionKey(Object encryptionKey)

Set a key to encrypt the database with. If the database does not exist and is being created, it will use this key, and the same key must be given every time it's opened

Parameters:

encryptionKey - the key

getConflictResolver

public ConflictResolver getConflictResolver()

setConflictResolver

public void setConflictResolver(ConflictResolver conflictResolver)