com.couchbase.lite

Class DatabaseConfiguration

java.lang.Object

com.couchbase.lite.DatabaseConfiguration

public final class DatabaseConfiguration
extends Object

Configuration for opening a database.

Constructor Summary

Constructors

Constructor and Description
DatabaseConfiguration(android.content.Context context)
DatabaseConfiguration(DatabaseConfiguration config)

Method Summary

Modifier and Type	Method and Description
ConflictResolver	getConflictResolver() Returns the conflict resolver for this database.
String	getDirectory() Returns the path to the directory to store the database in.
EncryptionKey	getEncryptionKey() Returns a key to encrypt the database with.
DatabaseConfiguration	setConflictResolver(ConflictResolver conflictResolver) Sets a custom conflict resolver used for solving the conflicts when saving or deleting documents in the database.
DatabaseConfiguration	setDirectory(String directory) Set the path to the directory to store the database in.
DatabaseConfiguration	setEncryptionKey(EncryptionKey encryptionKey) Set a key to encrypt the database with.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseConfiguration

public DatabaseConfiguration(android.content.Context context)

DatabaseConfiguration

public DatabaseConfiguration(DatabaseConfiguration config)

Method Detail

setDirectory

public DatabaseConfiguration setDirectory(String 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

Returns:

The self object.

setEncryptionKey

public DatabaseConfiguration setEncryptionKey(EncryptionKey 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

Returns:

The self object.

setConflictResolver

public DatabaseConfiguration setConflictResolver(ConflictResolver conflictResolver)

Sets a custom conflict resolver used for solving the conflicts when saving or deleting documents in the database. Without setting the conflict resolver, CouchbaseLite will use the default conflict resolver.

Parameters:

conflictResolver - The conflict resolver.

Returns:

The self object.

getDirectory

public String getDirectory()

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

Returns:

the directory

getEncryptionKey

public EncryptionKey getEncryptionKey()

Returns a key to encrypt the database with.

Returns:

the key

getConflictResolver

public ConflictResolver getConflictResolver()

Returns the conflict resolver for this database.

Returns:

the conflict resolver