Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abs(Expression) - Static method in class com.couchbase.lite.Function
-
Creates an ABS(expr) function that returns the absolute value of the given numeric expression.
- AbstractIndex - Class in com.couchbase.lite
- AbstractIndex(AbstractIndex.IndexType, AbstractIndex.QueryLanguage) - Constructor for class com.couchbase.lite.AbstractIndex
- AbstractIndex.IndexType - Enum Class in com.couchbase.lite
- AbstractIndex.QueryLanguage - Enum Class in com.couchbase.lite
- AbstractReplicator - Class in com.couchbase.lite
-
A replicator for replicating document changes between a local database and a target database.
- AbstractReplicator(ReplicatorConfiguration) - Constructor for class com.couchbase.lite.AbstractReplicator
-
Initializes a replicator with the given configuration.
- AbstractReplicatorConfiguration - Class in com.couchbase.lite
-
Replicator configuration.
- AbstractReplicatorConfiguration(AbstractReplicatorConfiguration) - Constructor for class com.couchbase.lite.AbstractReplicatorConfiguration
- AbstractReplicatorConfiguration(Database, Map<Collection, CollectionConfiguration>, Endpoint) - Constructor for class com.couchbase.lite.AbstractReplicatorConfiguration
- AbstractReplicatorConfiguration.ReplicatorType - Enum Class in com.couchbase.lite
-
Deprecated.Use com.couchbase.lite.ReplicatorType
- accept(MessageEndpointConnection) - Method in class com.couchbase.lite.MessageEndpointListener
-
Accept a new connection.
- ACCEPT_PARENT_COOKIES - Static variable in class com.couchbase.lite.Defaults.Replicator
-
Whether or not a replicator only accepts cookies for the sender's parent domains
- ACCESS_REMOVED - Enum constant in enum class com.couchbase.lite.DocumentFlag
-
The current access removed status of the document.
- acos(Expression) - Static method in class com.couchbase.lite.Function
-
Creates an ACOS(expr) function that returns the inverse cosine of the given numeric expression.
- add(Expression) - Method in class com.couchbase.lite.Expression
-
Create an add expression to add the given expression to the current expression
- addArray(Array) - Method in class com.couchbase.lite.MutableArray
-
Adds an Array object to the end of the array.
- addBlob(Blob) - Method in class com.couchbase.lite.MutableArray
-
Adds a Blob object to the end of the array.
- addBoolean(boolean) - Method in class com.couchbase.lite.MutableArray
-
Adds a boolean value to the end of the array.
- addChangeListener(CollectionChangeListener) - Method in class com.couchbase.lite.Collection
-
Add a change listener to listen to change events occurring to any documents in the collection.
- addChangeListener(DatabaseChangeListener) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().addChangeListener
- addChangeListener(MessageEndpointListenerChangeListener) - Method in class com.couchbase.lite.MessageEndpointListener
-
Add a change listener.
- addChangeListener(QueryChangeListener) - Method in class com.couchbase.lite.GroupBy
-
Adds a query change listener.
- addChangeListener(QueryChangeListener) - Method in interface com.couchbase.lite.Query
-
Adds a change listener for the changes that occur in the query results.
- addChangeListener(ReplicatorChangeListener) - Method in class com.couchbase.lite.AbstractReplicator
-
Adds a change listener for the changes in the replication status and progress.
- addChangeListener(Executor, CollectionChangeListener) - Method in class com.couchbase.lite.Collection
-
Add a change listener to listen to change events occurring to any documents in the collection.
- addChangeListener(Executor, DatabaseChangeListener) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().addChangeListener
- addChangeListener(Executor, MessageEndpointListenerChangeListener) - Method in class com.couchbase.lite.MessageEndpointListener
-
Add a change listener with the given dispatch queue.
- addChangeListener(Executor, QueryChangeListener) - Method in class com.couchbase.lite.GroupBy
-
Adds a query change listener with the dispatch queue on which changes will be posted.
- addChangeListener(Executor, QueryChangeListener) - Method in interface com.couchbase.lite.Query
-
Adds a change listener for the changes that occur in the query results with an executor on which the changes will be posted to the listener.
- addChangeListener(Executor, ReplicatorChangeListener) - Method in class com.couchbase.lite.AbstractReplicator
-
Adds a change listener for the changes in the replication status and progress with an executor on which the changes will be posted to the listener.
- addCollection(Collection, CollectionConfiguration) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Add a collection used for the replication with an optional collection configuration.
- addCollections(Collection<Collection>, CollectionConfiguration) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Add multiple collections used for the replication with an optional shared collection configuration.
- addDate(Date) - Method in class com.couchbase.lite.MutableArray
-
Adds a Date object to the end of the array.
- addDictionary(Dictionary) - Method in class com.couchbase.lite.MutableArray
-
Adds a Dictionary object to the end of the array.
- addDocumentChangeListener(String, DocumentChangeListener) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().addDocumentChangeListener
- addDocumentChangeListener(String, DocumentChangeListener) - Method in class com.couchbase.lite.Collection
-
Add a change listener to listen to change events occurring to a document of the given document id.
- addDocumentChangeListener(String, Executor, DocumentChangeListener) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().addDocumentChangeListener
- addDocumentChangeListener(String, Executor, DocumentChangeListener) - Method in class com.couchbase.lite.Collection
-
Adds a change listener for the changes that occur to the specified document with an executor on which the changes will be posted to the listener.
- addDocumentReplicationListener(DocumentReplicationListener) - Method in class com.couchbase.lite.AbstractReplicator
-
Adds a listener for receiving the replication status of the specified document.
- addDocumentReplicationListener(Executor, DocumentReplicationListener) - Method in class com.couchbase.lite.AbstractReplicator
-
Adds a listener for receiving the replication status of the specified document with an executor on which the status will be posted to the listener.
- addDouble(double) - Method in class com.couchbase.lite.MutableArray
-
Adds a double value to the end of the array.
- addFloat(float) - Method in class com.couchbase.lite.MutableArray
-
Adds a float value to the end of the array.
- addInt(int) - Method in class com.couchbase.lite.MutableArray
-
Adds an integer value to the end of the array.
- addLong(long) - Method in class com.couchbase.lite.MutableArray
-
Adds a long value to the end of the array.
- addNumber(Number) - Method in class com.couchbase.lite.MutableArray
-
Adds a Number object to the end of the array.
- addString(String) - Method in class com.couchbase.lite.MutableArray
-
Adds a String object to the end of the array.
- addValue(Object) - Method in class com.couchbase.lite.MutableArray
-
Adds an object to the end of the array.
- alias - Variable in class com.couchbase.lite.DataSource
- all() - Static method in class com.couchbase.lite.Expression
-
Creates a * expression to express all properties
- all() - Static method in class com.couchbase.lite.SelectResult
-
Creates a SelectResult that contains values for all properties matching the query.
- ALL_DOMAINS - Static variable in enum class com.couchbase.lite.LogDomain
- allResults() - Method in class com.couchbase.lite.ResultSet
-
Return a List of all Results.
- and(Expression) - Method in class com.couchbase.lite.Expression
-
Create a logical AND expression that performs logical AND operation with the current expression.
- ANDROID_KEY_STORE - Static variable in class com.couchbase.lite.KeyStoreUtils
- any(VariableExpression) - Static method in class com.couchbase.lite.ArrayExpression
-
Creates an ANY Quantified operator (ANY <variable name> IN <expr> SATISFIES <expr>) with the given variable name.
- anyAndEvery(VariableExpression) - Static method in class com.couchbase.lite.ArrayExpression
-
Creates an ANY AND EVERY Quantified operator (ANY AND EVERY <variable name> IN <expr> SATISFIES <expr>) with the given variable name.
- Array - Class in com.couchbase.lite
-
Array provides readonly access to array data.
- Array() - Constructor for class com.couchbase.lite.Array
- Array(MArray) - Constructor for class com.couchbase.lite.Array
- ArrayExpression - Class in com.couchbase.lite
-
Array expression
- ArrayExpressionIn - Class in com.couchbase.lite
-
The In class represents the IN clause object in a quantified operator (ANY/ANY AND EVERY/EVERY <variable name> IN <expr> SATISFIES <expr>).
- ArrayExpressionSatisfies - Class in com.couchbase.lite
-
The Satisfies class represents the SATISFIES clause object in a quantified operator (ANY/ANY AND EVERY/EVERY <variable name> IN <expr> SATISFIES <expr>).
- ArrayFunction - Class in com.couchbase.lite
-
Function provides array functions.
- ArrayInterface - Interface in com.couchbase.lite
-
Internal interface
- as(String) - Method in class com.couchbase.lite.DataSource.As
-
Set an alias to the database data source.
- as(String) - Method in class com.couchbase.lite.SelectResult.As
-
Specifies the alias for the SelectResult object.
- ascending() - Method in class com.couchbase.lite.Ordering.SortOrder
-
Set the order as ascending order.
- ascii() - Static method in class com.couchbase.lite.Collation
-
Creates an ASCII collation that will compare two strings by using binary comparison.
- asin(Expression) - Static method in class com.couchbase.lite.Function
-
Creates an ASIN(expr) function that returns the inverse sin of the given numeric expression.
- ASSERTION_FAILED - Static variable in class com.couchbase.lite.CBLError.Code
-
Internal assertion failure
- assertOpenChecked() - Method in class com.couchbase.lite.BaseDatabase
- assertOpenUnchecked() - Method in class com.couchbase.lite.BaseDatabase
- atan(Expression) - Static method in class com.couchbase.lite.Function
-
Creates an ATAN(expr) function that returns the inverse tangent of the numeric expression.
- atan2(Expression, Expression) - Static method in class com.couchbase.lite.Function
-
Returns the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta).
- authenticate(String, char[]) - Method in interface com.couchbase.lite.ListenerPasswordAuthenticatorDelegate
-
Authenticate a client based on the passed credentials.
- authenticate(List<Certificate>) - Method in interface com.couchbase.lite.ListenerCertificateAuthenticatorDelegate
-
Authenticate a client based on the passed certificates.
- authenticate(Map<String, Object>) - Method in class com.couchbase.lite.BasicAuthenticator
- authenticate(Map<String, Object>) - Method in class com.couchbase.lite.ClientCertificateAuthenticator
- authenticate(Map<String, Object>) - Method in class com.couchbase.lite.SessionAuthenticator
- Authenticator - Interface in com.couchbase.lite
-
Authenticator is an opaque interface.
- avg(Expression) - Static method in class com.couchbase.lite.Function
-
Creates an AVG(expr) function expression that returns the average of all the number values in the group of the values expressed by the given expression.
B
- BAD_DOC_ID - Static variable in class com.couchbase.lite.CBLError.Code
-
Invalid document ID
- BAD_REVISION_ID - Static variable in class com.couchbase.lite.CBLError.Code
-
An was made to insert a document with an invalid revision ID This is frequently caused by an invalid revision ID written directly into Sync Gateway via the REST API
- BaseDatabase - Class in com.couchbase.lite
- BaseDatabase() - Constructor for class com.couchbase.lite.BaseDatabase
- BasicAuthenticator - Class in com.couchbase.lite
-
The BasicAuthenticator class is an authenticator that will authenticate using HTTP Basic auth with the given username and password.
- BasicAuthenticator(String, char[]) - Constructor for class com.couchbase.lite.BasicAuthenticator
-
Create a Basic Authenticator.
- between(Expression, Expression) - Method in class com.couchbase.lite.Expression
-
Create a between expression that evaluates whether or not the current expression is between the given expressions inclusively.
- Blob - Class in com.couchbase.lite
-
A Couchbase Lite Blob.
- Blob(String, byte[]) - Constructor for class com.couchbase.lite.Blob
-
Construct a Blob with the given in-memory data.
- Blob(String, InputStream) - Constructor for class com.couchbase.lite.Blob
-
Construct a Blob with the given stream of data.
- Blob(String, URL) - Constructor for class com.couchbase.lite.Blob
-
Construct a Blob with the content of a file.
- booleanValue(boolean) - Static method in class com.couchbase.lite.Expression
-
Create value expression with given boolean value
- BUSY - Enum constant in enum class com.couchbase.lite.ReplicatorActivityLevel
-
The replication is actively transferring data.
- BUSY - Static variable in class com.couchbase.lite.CBLError.Code
-
Database is busy / locked
- BYTE_STREAM - Enum constant in enum class com.couchbase.lite.ProtocolType
C
- CANT_OPEN_FILE - Static variable in class com.couchbase.lite.CBLError.Code
-
Database file can't be opened; may not exist
- CANT_UPGRADE_DATABASE - Static variable in class com.couchbase.lite.CBLError.Code
-
Database can't be upgraded (might be unsupported dev version)
- CBLError - Class in com.couchbase.lite
- CBLError.Code - Class in com.couchbase.lite
- CBLError.Domain - Class in com.couchbase.lite
-
The error type: roughly, where it originated.
- CBLITE - Static variable in class com.couchbase.lite.CBLError.Domain
- ceil(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a CEIL(expr) function that returns the ceiling value of the given numeric expression.
- changed(DocumentChange) - Method in interface com.couchbase.lite.DocumentChangeListener
-
Callback function from Database when the specified document is updated.
- changed(MessageEndpointListenerChange) - Method in interface com.couchbase.lite.MessageEndpointListenerChangeListener
- changed(QueryChange) - Method in interface com.couchbase.lite.QueryChangeListener
-
The callback function from live query
- changed(ReplicatorChange) - Method in interface com.couchbase.lite.ReplicatorChangeListener
-
The callback function from Replicator
- changed(T) - Method in interface com.couchbase.lite.ChangeListener
- changeEncryptionKey(EncryptionKey) - Method in class com.couchbase.lite.Database
-
ENTERPRISE EDITION API
- ChangeListener<T> - Interface in com.couchbase.lite
- ClientCertificateAuthenticator - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- ClientCertificateAuthenticator(TLSIdentity) - Constructor for class com.couchbase.lite.ClientCertificateAuthenticator
-
Creates a ClientCertificateAuthenticator object with the given client identity.
- close() - Method in class com.couchbase.lite.Database
-
Closes a database.
- close() - Method in class com.couchbase.lite.AbstractReplicator
- close() - Method in class com.couchbase.lite.Collection
- close() - Method in class com.couchbase.lite.ListenerToken
- close() - Method in class com.couchbase.lite.ResultSet
- close(MessageEndpointConnection) - Method in class com.couchbase.lite.MessageEndpointListener
-
Close the given connection.
- close(MessagingError) - Method in interface com.couchbase.lite.ReplicatorConnection
-
Tells the replicator to close the current connection.
- close(Exception, MessagingCloseCompletion) - Method in interface com.couchbase.lite.MessageEndpointConnection
-
Called to close the remote connection with the other peer when the replicator stops or when the MessageEndpointListener closes the connection.
- closeAll() - Method in class com.couchbase.lite.MessageEndpointListener
-
Close all connections active at the time of the call.
- code - Variable in exception com.couchbase.lite.LiteCoreException
- collate(Collation) - Method in class com.couchbase.lite.Expression
-
Creates a Collate expression with the given Collation specification.
- Collation - Class in com.couchbase.lite
-
Collation defines how strings are compared and is used when creating a COLLATE expression.
- Collation(boolean, String) - Constructor for class com.couchbase.lite.Collation
- Collation.ASCII - Class in com.couchbase.lite
-
ASCII collation compares two strings by using binary comparison.
- Collation.Unicode - Class in com.couchbase.lite
-
Unicode Collation that will compare two strings by using Unicode collation algorithm.
- collection(Collection) - Static method in class com.couchbase.lite.DataSource
-
Create a collection as a data source.
- Collection - Class in com.couchbase.lite
-
A
Collection
is a container for documents similar to aa table in a relational database. - CollectionChange - Class in com.couchbase.lite
-
Provides details about a Collection change.
- CollectionChangeListener - Interface in com.couchbase.lite
-
The listener interface for receiving Collection change events.
- CollectionConfiguration - Class in com.couchbase.lite
- CollectionConfiguration() - Constructor for class com.couchbase.lite.CollectionConfiguration
- CollectionConfiguration(List<String>, List<String>, ReplicationFilter, ReplicationFilter, ConflictResolver) - Constructor for class com.couchbase.lite.CollectionConfiguration
- com.couchbase.lite - package com.couchbase.lite
- COMPACT - Enum constant in enum class com.couchbase.lite.MaintenanceType
-
Shrinks the database file by removing any empty pages, and deletes blobs that are no longer referenced by any documents.
- complete() - Method in interface com.couchbase.lite.MessagingCloseCompletion
-
Acknowledges completion of the close operation.
- complete(boolean, MessagingError) - Method in interface com.couchbase.lite.MessagingCompletion
-
Acknowledges completion of the operation.
- ConcurrencyControl - Enum Class in com.couchbase.lite
-
ConcurrencyControl type used when saving or deleting a document.
- config - Variable in class com.couchbase.lite.Database
- configureDefaultCollection(Database) - Static method in class com.couchbase.lite.AbstractReplicatorConfiguration
- Conflict - Class in com.couchbase.lite
-
The representation of conflicting changes in the remote and local instances of a document.
- CONFLICT - Static variable in class com.couchbase.lite.CBLError.Code
-
Document update conflict
- ConflictHandler - Interface in com.couchbase.lite
- ConflictResolver - Interface in com.couchbase.lite
-
Custom conflict resolution strategies implement this interface.
- CONNECTING - Enum constant in enum class com.couchbase.lite.ReplicatorActivityLevel
-
The replicator is connecting to the remote host.
- ConnectionStatus - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
Connection Status - ConnectionStatus(int, int) - Constructor for class com.couchbase.lite.ConnectionStatus
- ConsoleLogger - Class in com.couchbase.lite
-
A class that sends log messages to Android's system log, available via 'adb logcat'.
- contains(Expression, Expression) - Static method in class com.couchbase.lite.Function
-
Creates a CONTAINS(expr, substr) function that evaluates whether the given string expression conatins the given substring expression or not.
- contains(Expression, Expression) - Static method in class com.couchbase.lite.ArrayFunction
-
Creates an ARRAY_CONTAINS(expr, value) function that checks whether the given array expression contains the given value or not.
- contains(String) - Method in class com.couchbase.lite.Dictionary
-
Tests whether a property exists or not.
- contains(String) - Method in interface com.couchbase.lite.DictionaryInterface
- contains(String) - Method in class com.couchbase.lite.Document
-
Tests whether a property exists or not.
- contains(String) - Method in class com.couchbase.lite.Result
-
Tests whether key exists or not.
- CONTINUOUS - Static variable in class com.couchbase.lite.Defaults.Replicator
-
One-shot replication is used, and will stop once all initial changes are processed
- convertException(LiteCoreException) - Static method in exception com.couchbase.lite.CouchbaseLiteException
- convertException(LiteCoreException, String) - Static method in exception com.couchbase.lite.CouchbaseLiteException
- copy(File, String, DatabaseConfiguration) - Static method in class com.couchbase.lite.Database
-
Make a copy of a database in a new location.
- copy(File, String, String, int, byte[]) - Static method in class com.couchbase.lite.Database
- CORRUPT_DATA - Static variable in class com.couchbase.lite.CBLError.Code
-
Data is corrupted
- CORRUPT_REVISION_DATA - Static variable in class com.couchbase.lite.CBLError.Code
-
Revision contains corrupted/unreadable data
- cos(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a COS(expr) function that returns the cosine of the given numeric expression.
- cosineDistance(Expression, Expression) - Static method in class com.couchbase.lite.Function
-
ENTERPRISE EDITION API
- CouchbaseLite - Class in com.couchbase.lite
- CouchbaseLiteException - Exception in com.couchbase.lite
-
Misfortune: The little fox gets its tail wet.
- CouchbaseLiteException() - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
This method is not part of the public API.
- CouchbaseLiteException(Exception) - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
Deprecated.Must supply an error message
- CouchbaseLiteException(String) - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
Constructs a new exception with the specified detail message.
- CouchbaseLiteException(String, int) - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
Deprecated.Must supply an error message
- CouchbaseLiteException(String, int, Exception) - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
Deprecated.Must supply an error message
- CouchbaseLiteException(String, int, Map<String, Object>) - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
Deprecated.Must supply an error message
- CouchbaseLiteException(String, Exception) - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
Constructs a new exception with the specified cause
- CouchbaseLiteException(String, Exception, String, int) - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
Constructs a new exception with the specified error domain, error code and the specified cause
- CouchbaseLiteException(String, Exception, String, int, Map<String, Object>) - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
This method is not part of the public API.
- CouchbaseLiteException(String, String, int) - Constructor for exception com.couchbase.lite.CouchbaseLiteException
-
Constructs a new exception with the specified detail message, error domain and error code
- count() - Method in class com.couchbase.lite.Array
-
Gets a number of the items in the array.
- count() - Method in interface com.couchbase.lite.ArrayInterface
- count() - Method in class com.couchbase.lite.Dictionary
-
Gets the number of the entries in the dictionary.
- count() - Method in interface com.couchbase.lite.DictionaryInterface
- count() - Method in class com.couchbase.lite.Document
-
Gets the number of the entries in the document.
- count() - Method in class com.couchbase.lite.Result
- count(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a COUNT(expr) function expression that returns the count of all values in the group of the values expressed by the given expression.
- createCollection(String) - Method in class com.couchbase.lite.Database
-
Create a named collection in the default scope.
- createCollection(String, String) - Method in class com.couchbase.lite.Database
-
Create a named collection in the specified scope.
- createConnection(MessageEndpoint) - Method in interface com.couchbase.lite.MessageEndpointDelegate
-
Creates an object of type MessageEndpointConnection interface.
- createFilterDocument(String, String, FLDict) - Method in class com.couchbase.lite.Collection
- createIdentity(boolean, Map<String, String>, Date, String) - Static method in class com.couchbase.lite.TLSIdentity
-
Create self-signed certificate and private key, store them in the canonical keystore, and return a identity backed by the new entry.
- createIndex(String, Index) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().createIndex
- createIndex(String, Index) - Method in class com.couchbase.lite.Collection
-
Add an index to the collection.
- createIndex(String, IndexConfiguration) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().createIndex
- createIndex(String, IndexConfiguration) - Method in class com.couchbase.lite.Collection
-
Add an index to the collection.
- createQuery(String) - Method in class com.couchbase.lite.Database
-
Create a SQL++ query.
- createQuery(String, Database) - Static method in class com.couchbase.lite.QueryBuilder
-
Create Query from a N1QL string
- createReplicatorForTarget(Endpoint) - Method in class com.couchbase.lite.AbstractReplicator
- createReplicatorForTarget(Endpoint) - Method in class com.couchbase.lite.Replicator
- crossJoin(DataSource) - Static method in class com.couchbase.lite.Join
-
Create an CROSS JOIN component with the given data source.
- CRYPTO - Static variable in class com.couchbase.lite.CBLError.Code
-
Encryption / Decryption error
D
- database(Database) - Static method in class com.couchbase.lite.DataSource
-
Deprecated.use DataSource.collection(Collection)
- Database - Class in com.couchbase.lite
-
A Couchbase Lite database.
- Database(String) - Constructor for class com.couchbase.lite.Database
-
Construct a Database with a given name and the default config.
- Database(String, DatabaseConfiguration) - Constructor for class com.couchbase.lite.Database
-
Construct a Database with a given name and database config.
- DATABASE - Enum constant in enum class com.couchbase.lite.LogDomain
- DATABASE_TOO_NEW - Static variable in class com.couchbase.lite.CBLError.Code
-
Database file format is newer than what I can open
- DATABASE_TOO_OLD - Static variable in class com.couchbase.lite.CBLError.Code
-
Database file format is older than what I can open
- DatabaseChange - Class in com.couchbase.lite
-
Deprecated.Use CollectionChange
- DatabaseChangeListener - Interface in com.couchbase.lite
-
Deprecated.Use CollectionChangeListener
- DatabaseConfiguration - Class in com.couchbase.lite
-
Configuration for opening a database.
- DatabaseConfiguration() - Constructor for class com.couchbase.lite.DatabaseConfiguration
- DatabaseConfiguration(DatabaseConfiguration) - Constructor for class com.couchbase.lite.DatabaseConfiguration
-
Copy constructor
- DatabaseEndpoint - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- DatabaseEndpoint(Database) - Constructor for class com.couchbase.lite.DatabaseEndpoint
-
Constructor with the database instance
- DataSource - Class in com.couchbase.lite
-
A query data source, used for specifying the source of data for a query.
- DataSource.As - Class in com.couchbase.lite
-
Database as a data source for query.
- date(Date) - Static method in class com.couchbase.lite.Expression
-
Create value expression with given Date value
- DEBUG - Enum constant in enum class com.couchbase.lite.LogLevel
-
Debugging information.
- DEFAULT - Static variable in interface com.couchbase.lite.ConflictResolver
-
The default conflict resolution strategy.
- DEFAULT_NAME - Static variable in class com.couchbase.lite.Collection
- DEFAULT_NAME - Static variable in class com.couchbase.lite.Scope
- Defaults - Class in com.couchbase.lite
- Defaults.Database - Class in com.couchbase.lite
- Defaults.FullTextIndex - Class in com.couchbase.lite
- Defaults.Listener - Class in com.couchbase.lite
- Defaults.LogFile - Class in com.couchbase.lite
- Defaults.Replicator - Class in com.couchbase.lite
- degrees(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a DEGREES(expr) function that returns the degrees value of the given radiants value expression.
- delete() - Method in class com.couchbase.lite.Database
-
Deletes a database.
- delete(Document) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().delete
- delete(Document) - Method in class com.couchbase.lite.Collection
-
Delete a document from the collection.
- delete(Document, ConcurrencyControl) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().delete
- delete(Document, ConcurrencyControl) - Method in class com.couchbase.lite.Collection
-
Delete a document from the collection with a specified concurrency control.
- delete(String, File) - Static method in class com.couchbase.lite.Database
-
Deletes a database of the given name in the given directory.
- deleteCollection(String) - Method in class com.couchbase.lite.Database
-
Delete a collection by name in the default scope.
- deleteCollection(String, String) - Method in class com.couchbase.lite.Database
-
Delete a collection by name in the specified scope.
- deleted - Static variable in class com.couchbase.lite.Meta
-
A metadata expression referring to the deleted boolean flag of the document.
- DELETED - Enum constant in enum class com.couchbase.lite.DocumentFlag
-
The current deleted status of the document.
- deleteIndex(String) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().deleteIndex
- deleteIndex(String) - Method in class com.couchbase.lite.Collection
-
Delete the named index from the collection.
- descending() - Method in class com.couchbase.lite.Ordering.SortOrder
-
Set the order as descending order.
- Dictionary - Class in com.couchbase.lite
-
Dictionary provides readonly access to dictionary data.
- Dictionary(MDict) - Constructor for class com.couchbase.lite.Dictionary
- DictionaryInterface - Interface in com.couchbase.lite
-
This is an internal interface and not part of the public API.
- digest() - Method in class com.couchbase.lite.Blob
-
The cryptographic digest of this Blob's contents, which uniquely identifies it.
- DISABLE_HEARTBEAT - Static variable in class com.couchbase.lite.AbstractReplicatorConfiguration
-
This is a long time: just under 25 days.
- DISABLE_TLS - Static variable in class com.couchbase.lite.Defaults.Listener
-
TLS is enabled on the connection
- dispatchStatusChanged(C4Replicator, C4ReplicatorStatus) - Method in class com.couchbase.lite.MessageEndpointListener
- divide(Expression) - Method in class com.couchbase.lite.Expression
-
Create a divide expression to divide the current expression by the given expression.
- DNS_FAILURE - Static variable in class com.couchbase.lite.CBLError.Code
-
DNS Lookup failed
- Document - Class in com.couchbase.lite
-
Readonly version of the Document.
- Document(Collection, String, C4Document, boolean) - Constructor for class com.couchbase.lite.Document
- DocumentChange - Class in com.couchbase.lite
-
Provides details about a Document change.
- DocumentChangeListener - Interface in com.couchbase.lite
-
The listener interface for receiving Document change events.
- DocumentFlag - Enum Class in com.couchbase.lite
-
The flags enum describing the replicated document.
- DocumentReplication - Class in com.couchbase.lite
-
The representation of the replication of a document.
- DocumentReplicationListener - Interface in com.couchbase.lite
-
The listener interface for receiving Document replicated events.
- doLog(LogLevel, LogDomain, String) - Method in class com.couchbase.lite.ConsoleLogger
- domain - Variable in exception com.couchbase.lite.LiteCoreException
- DOMAIN - Static variable in class com.couchbase.lite.GroupBy
- doubleValue(double) - Static method in class com.couchbase.lite.Expression
-
Create value expression with given double value
E
- e() - Static method in class com.couchbase.lite.Function
-
Creates a E() function that return the value of the mathematical constant 'e'.
- ENABLE_AUTO_PURGE - Static variable in class com.couchbase.lite.Defaults.Replicator
-
Purge documents when a user loses access
- ENABLE_DELTA_SYNC - Static variable in class com.couchbase.lite.Defaults.Listener
-
Delta sync is disabled for the listener
- ENCODER_ARG_DB - Static variable in class com.couchbase.lite.Blob
- ENCODER_ARG_QUERY_PARAM - Static variable in class com.couchbase.lite.Blob
- encodeTo(FLEncoder) - Method in class com.couchbase.lite.Array
- encodeTo(FLEncoder) - Method in class com.couchbase.lite.Blob
-
This method is not part of the public API: Do not use it.
- encodeTo(FLEncoder) - Method in class com.couchbase.lite.Dictionary
- EncryptionKey - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- EncryptionKey(byte[]) - Constructor for class com.couchbase.lite.EncryptionKey
-
Initializes the encryption key with a raw AES-128 key 16 bytes in length.
- EncryptionKey(String) - Constructor for class com.couchbase.lite.EncryptionKey
-
Initializes the encryption key from the given password string.
- Endpoint - Interface in com.couchbase.lite
-
Replication target endpoint interface
- equals(Object) - Method in class com.couchbase.lite.Database
- equals(Object) - Method in class com.couchbase.lite.Array
- equals(Object) - Method in class com.couchbase.lite.Blob
-
Compare for equality.
- equals(Object) - Method in class com.couchbase.lite.Collection
- equals(Object) - Method in class com.couchbase.lite.Dictionary
- equals(Object) - Method in class com.couchbase.lite.Document
- equals(Object) - Method in class com.couchbase.lite.LogFileConfiguration
- equals(Object) - Method in class com.couchbase.lite.Scope
- equalTo(Expression) - Method in class com.couchbase.lite.Expression
-
Create an equal to expression that evaluates whether or not the current expression is equal to the given expression.
- ERROR - Enum constant in enum class com.couchbase.lite.LogLevel
-
Internal errors that are unrecoverable
- euclideanDistance(Expression, Expression) - Static method in class com.couchbase.lite.Function
-
ENTERPRISE EDITION API
- every(VariableExpression) - Static method in class com.couchbase.lite.ArrayExpression
-
Creates an EVERY Quantified operator (EVERY <variable name> IN <expr> SATISFIES <expr>) with the given variable name.
- execute() - Method in class com.couchbase.lite.GroupBy
-
Executes the query returning a result set that enumerates result rows one at a time.
- execute() - Method in interface com.couchbase.lite.Query
-
Executes the query.
- exists(String, File) - Static method in class com.couchbase.lite.Database
-
Checks whether a database of the given name exists in the given directory or not.
- exp(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a EXP(expr) function that returns the value of 'e' power by the given numeric expression.
- expiration - Static variable in class com.couchbase.lite.Meta
-
A metadata expression referring to the expiration date of the document.
- explain() - Method in class com.couchbase.lite.GroupBy
-
Returns a string describing the implementation of the compiled query.
- explain() - Method in interface com.couchbase.lite.Query
-
Returns a string describing the implementation of the compiled query.
- expression(Expression) - Static method in class com.couchbase.lite.Ordering
-
Create a SortOrder, inherited from the OrderBy class, object by the given expression.
- expression(Expression) - Static method in class com.couchbase.lite.SelectResult
-
Creates a SelectResult object with the given expression.
- expression(Expression) - Static method in class com.couchbase.lite.ValueIndexItem
-
Creates a value index item with the given property.
- Expression - Class in com.couchbase.lite
-
The expression used in constructing a query.
- Expression() - Constructor for class com.couchbase.lite.Expression
F
- FAIL_ON_CONFLICT - Enum constant in enum class com.couchbase.lite.ConcurrencyControl
-
The operation will fail if there is a conflict.
- FileLogger - Class in com.couchbase.lite
-
A logger for writing to a file in the application's storage so that log messages can persist durably after the application has stopped or encountered a problem.
- filtered(Document, EnumSet<DocumentFlag>) - Method in interface com.couchbase.lite.ReplicationFilter
- finalize() - Method in class com.couchbase.lite.Database
- finalize() - Method in class com.couchbase.lite.BasicAuthenticator
- finalize() - Method in class com.couchbase.lite.Blob
- finalize() - Method in class com.couchbase.lite.ResultSet
- FLEECE - Static variable in class com.couchbase.lite.CBLError.Domain
- floatValue(float) - Static method in class com.couchbase.lite.Expression
-
Create value expression with given float value
- floor(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a FLOOR(expr) function that returns the floor value of the given numeric expression.
- from(DataSource) - Method in class com.couchbase.lite.Select
-
Create and chain a FROM component for specifying the query's data source.
- from(String) - Method in interface com.couchbase.lite.FullTextIndexExpression
- from(String) - Method in class com.couchbase.lite.MetaExpression
-
Specifies an alias name of the data source to query the data from.
- from(String) - Method in class com.couchbase.lite.PropertyExpression
-
Specifies an alias name of the data source to query the data from.
- from(String) - Method in class com.couchbase.lite.SelectResult.From
-
Specifies the data source alias for the SelectResult object.
- From - Class in com.couchbase.lite
-
A From represents a FROM clause for specifying the data source of the query.
- fromData(byte[]) - Static method in class com.couchbase.lite.Message
-
Creates a message object from data.
- FULL_OPTIMIZE - Enum constant in enum class com.couchbase.lite.MaintenanceType
-
Fully scans all indexes to gather database statistics that help optimize queries.
- FULL_SYNC - Static variable in class com.couchbase.lite.Defaults.Database
-
Full sync is off by default
- FULL_TEXT - Enum constant in enum class com.couchbase.lite.AbstractIndex.IndexType
- FullTextExpression - Class in com.couchbase.lite
-
Deprecated.Use FullTextFunction.match()
- FullTextFunction - Class in com.couchbase.lite
-
Full-text functions.
- fullTextIndex(FullTextIndexItem...) - Static method in class com.couchbase.lite.IndexBuilder
-
Create a full-text search index with the given index item and options.
- fullTextIndex(String) - Static method in class com.couchbase.lite.Expression
-
Create a full-text index expression referencing a full-text index with the given index name.
- FullTextIndex - Class in com.couchbase.lite
-
Index for Full-Text search
- FullTextIndexConfiguration - Class in com.couchbase.lite
-
Full Text Index Configuration
- FullTextIndexConfiguration(String...) - Constructor for class com.couchbase.lite.FullTextIndexConfiguration
- FullTextIndexExpression - Interface in com.couchbase.lite
- FullTextIndexItem - Class in com.couchbase.lite
-
Full-text Index Item.
- Function - Class in com.couchbase.lite
-
Query functions.
- Function() - Constructor for class com.couchbase.lite.Function
G
- getActiveConnectionCount() - Method in class com.couchbase.lite.ConnectionStatus
-
Get the count of clients that are currently actively transferring data.
- getActivityLevel() - Method in class com.couchbase.lite.ReplicatorStatus
-
The current activity level.
- getArray(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as an Array.
- getArray(int) - Method in interface com.couchbase.lite.ArrayInterface
- getArray(int) - Method in class com.couchbase.lite.MutableArray
-
Gets a Array at the given index.
- getArray(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as an Array.
- getArray(String) - Method in class com.couchbase.lite.Dictionary
-
Get a property's value as an Array.
- getArray(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getArray(String) - Method in class com.couchbase.lite.Document
-
Get a property's value as a Array.
- getArray(String) - Method in class com.couchbase.lite.MutableDictionary
-
Get a property's value as a Array.
- getArray(String) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- getArray(String) - Method in class com.couchbase.lite.MutableDocument
-
Get a property's value as a Array.
- getArray(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a Array Returns null if the key doesn't exist or if the value is not an Array
- getAuthenticator() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return the Authenticator used to authenticate the remote.
- getAuthenticator() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Get the configured authenticator.
- getBlob(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as a Blob.
- getBlob(int) - Method in interface com.couchbase.lite.ArrayInterface
- getBlob(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as a Blob.
- getBlob(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as a Blob.
- getBlob(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getBlob(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as a Blob.
- getBlob(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a Blob Returns null if the key doesn't exist or if the value is not a Blob
- getBlob(Map<String, Object>) - Method in class com.couchbase.lite.Database
-
(UNCOMMITTED) Use this API if you are developing Javascript language bindings.
- getBlobStore() - Method in class com.couchbase.lite.BaseDatabase
- getBoolean(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as a boolean.
- getBoolean(int) - Method in interface com.couchbase.lite.ArrayInterface
- getBoolean(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as a boolean.
- getBoolean(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as a boolean.
- getBoolean(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getBoolean(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as a boolean.
- getBoolean(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a boolean Returns false if the key doesn't exist or if the value is not a boolean
- getC4DbOrThrowLocked() - Method in class com.couchbase.lite.BaseDatabase
- getChannels() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.getChannels
- getChannels() - Method in class com.couchbase.lite.CollectionConfiguration
-
Sets a collection of Sync Gateway channel names from which to pull Documents.
- getCode() - Method in exception com.couchbase.lite.CouchbaseLiteException
-
Access the error code for this error.
- getCode() - Method in exception com.couchbase.lite.LiteCoreException
- getCollection() - Method in class com.couchbase.lite.DatabaseChange
-
Deprecated.Returns the collection
- getCollection() - Method in class com.couchbase.lite.Document
-
return the collection to which the document belongs.
- getCollection() - Method in class com.couchbase.lite.DocumentChange
-
Return the Document's collection
- getCollection() - Method in class com.couchbase.lite.ReplicatedDocument
-
The name of the collection to which the changed document belongs.
- getCollection(String) - Method in class com.couchbase.lite.Database
-
Get a collection in the default scope by name.
- getCollection(String) - Method in class com.couchbase.lite.Scope
-
Get the named collection for the scope.
- getCollection(String, String) - Method in class com.couchbase.lite.Database
-
Get a collection in the specified scope by name.
- getCollectionConfiguration(Collection) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Get the CollectionConfiguration for the passed Collection.
- getCollectionName() - Method in class com.couchbase.lite.ReplicatedDocument
-
Deprecated.Use getCollection()
- getCollections() - Method in class com.couchbase.lite.Database
-
Get all collections in the default scope.
- getCollections() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return the list of collections in the replicator configuration
- getCollections() - Method in class com.couchbase.lite.MessageEndpointListenerConfiguration
- getCollections() - Method in class com.couchbase.lite.Scope
-
Get all collections in the scope.
- getCollections() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Get the configured database.
- getCollections(String) - Method in class com.couchbase.lite.Database
-
Get all collections in the named scope.
- getCollectionScope() - Method in class com.couchbase.lite.ReplicatedDocument
-
Deprecated.Use getScope()
- getCompleted() - Method in class com.couchbase.lite.ReplicatorProgress
-
The number of completed changes processed.
- getConfig() - Method in class com.couchbase.lite.Database
-
Returns a copy of the database configuration.
- getConfig() - Method in class com.couchbase.lite.AbstractReplicator
-
The replicator's configuration.
- getConfig() - Method in class com.couchbase.lite.FileLogger
-
Gets the configuration currently in use by the file logger.
- getConfig() - Method in class com.couchbase.lite.URLEndpointListener
-
Get the listener's configuration.
- getConflictResolver() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.getConflictResolver
- getConflictResolver() - Method in class com.couchbase.lite.CollectionConfiguration
-
Return the conflict resolver.
- getConnection() - Method in class com.couchbase.lite.MessageEndpointListenerChange
-
Return connection
- getConnectionCount() - Method in class com.couchbase.lite.ConnectionStatus
-
Get the count of clients currently connected to this listener.
- getConsole() - Method in class com.couchbase.lite.Log
-
Gets the logger that writes to the system console
- getContent() - Method in class com.couchbase.lite.Blob
-
Gets the contents of this blob as in in-memory byte array.
- getContent() - Method in class com.couchbase.lite.Document
- getContentStream() - Method in class com.couchbase.lite.Blob
-
Get a the contents of this blob as a stream.
- getContentType() - Method in class com.couchbase.lite.Blob
-
Return the type of of the content this blob contains.
- getCookieName() - Method in class com.couchbase.lite.SessionAuthenticator
-
Return session cookie name that the session ID value will be set to when communicating the Sync Gateway.
- getCount() - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().getCount()
- getCount() - Method in class com.couchbase.lite.Collection
-
The number of documents in the collection.
- getCustom() - Method in class com.couchbase.lite.Log
-
Gets the custom logger that was registered by the application (if any)
- getDatabase() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use Collection.getDatabase
- getDatabase() - Method in class com.couchbase.lite.GroupBy
-
Get the database to which this query will be applied.
- getDatabase() - Method in class com.couchbase.lite.Database
- getDatabase() - Method in class com.couchbase.lite.DatabaseChange
-
Deprecated.Returns the database instance
- getDatabase() - Method in class com.couchbase.lite.DatabaseEndpoint
-
Return the Database instance
- getDatabase() - Method in class com.couchbase.lite.DocumentChange
-
Deprecated.Use DocumentChange.getCollection()
- getDatabase() - Method in class com.couchbase.lite.MessageEndpointListenerConfiguration
-
Deprecated.Use getCollections()
- getDatabase() - Method in class com.couchbase.lite.ResultContext
- getDatabase() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Deprecated.use getCollections()
- getDatabaseConfiguration() - Method in class com.couchbase.lite.DatabaseConfiguration
- getDate(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as a Date.
- getDate(int) - Method in interface com.couchbase.lite.ArrayInterface
- getDate(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as a Date.
- getDate(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as a Date.
- getDate(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getDate(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as a Date.
- getDate(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a Date Returns null if the key doesn't exist or if the value is not a Date
- getDbLock() - Method in class com.couchbase.lite.BaseDatabase
- getDbPath() - Method in class com.couchbase.lite.BaseDatabase
- getDefaultCollection() - Method in class com.couchbase.lite.Database
-
Get the default collection.
- getDefaultScope() - Method in class com.couchbase.lite.Database
-
Get the default scope.
- getDelegate() - Method in class com.couchbase.lite.MessageEndpoint
-
Gets the delegate object used for creating MessageEndpointConnection objects.
- getDictionary(int) - Method in class com.couchbase.lite.Array
-
Gets a Dictionary at the given index.
- getDictionary(int) - Method in interface com.couchbase.lite.ArrayInterface
- getDictionary(int) - Method in class com.couchbase.lite.MutableArray
-
Gets a Dictionary at the given index.
- getDictionary(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as a Dictionary.
- getDictionary(String) - Method in class com.couchbase.lite.Dictionary
-
Get a property's value as a Dictionary.
- getDictionary(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getDictionary(String) - Method in class com.couchbase.lite.Document
-
Get a property's value as a Dictionary.
- getDictionary(String) - Method in class com.couchbase.lite.MutableDictionary
-
Get a property's value as a Dictionary.
- getDictionary(String) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- getDictionary(String) - Method in class com.couchbase.lite.MutableDocument
-
Get a property's value as a Dictionary.
- getDictionary(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a Dictionary Returns null if the key doesn't exist or if the value is not a Dictionary
- getDirectory() - Method in class com.couchbase.lite.DatabaseConfiguration
-
Returns the path to the directory that contains the database.
- getDirectory() - Method in class com.couchbase.lite.LogFileConfiguration
-
Gets the directory that the logs files are stored in.
- getDocument(String) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().getDocument()
- getDocument(String) - Method in class com.couchbase.lite.Collection
-
Gets an existing Document object with the given ID.
- getDocumentExpiration(String) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().getDocumentExpiration
- getDocumentExpiration(String) - Method in class com.couchbase.lite.Collection
-
Get the expiration date set to the document of the given id.
- getDocumentId() - Method in class com.couchbase.lite.Conflict
-
The id of the conflicted document
- getDocumentID() - Method in class com.couchbase.lite.DocumentChange
-
Returns the changed document ID
- getDocumentIDs() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.getDocumentIDs
- getDocumentIDs() - Method in class com.couchbase.lite.CollectionConfiguration
-
A collection of document IDs to filter: if not nil, only documents with these IDs will be pushed and/or pulled.
- getDocumentIDs() - Method in class com.couchbase.lite.DatabaseChange
-
Deprecated.Returns the list of the changed document IDs
- getDocuments() - Method in class com.couchbase.lite.DocumentReplication
-
The list of affected documents.
- getDomain() - Method in exception com.couchbase.lite.CouchbaseLiteException
-
Access the error domain for this error.
- getDomain() - Method in exception com.couchbase.lite.LiteCoreException
- getDomains() - Method in class com.couchbase.lite.ConsoleLogger
-
Get the set of domains currently being logged to the console.
- getDouble(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as an double.
- getDouble(int) - Method in interface com.couchbase.lite.ArrayInterface
- getDouble(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as a double.
- getDouble(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as an double.
- getDouble(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getDouble(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as an double.
- getDouble(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a double Returns 0.0 if the key doesn't exist or if the value is not a double
- getEncryptionKey() - Method in class com.couchbase.lite.DatabaseConfiguration
-
ENTERPRISE EDITION API
- getError() - Method in class com.couchbase.lite.MessagingError
-
Gets error object.
- getError() - Method in class com.couchbase.lite.QueryChange
-
Return the error occurred when running the query.
- getError() - Method in class com.couchbase.lite.ReplicatedDocument
-
The current document replication error.
- getError() - Method in class com.couchbase.lite.ReplicatorStatus
- getExpressions() - Method in class com.couchbase.lite.IndexConfiguration
- getFile() - Method in class com.couchbase.lite.Log
-
Gets the logger that writes to log files
- getFlags() - Method in class com.couchbase.lite.ReplicatedDocument
-
The current status flag of the document.
- getFloat(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as an float.
- getFloat(int) - Method in interface com.couchbase.lite.ArrayInterface
- getFloat(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as a float.
- getFloat(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as an float.
- getFloat(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getFloat(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as an float.
- getFloat(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a float Returns 0.0F if the key doesn't exist or if the value is not a float
- getFramingForProtocol(ProtocolType) - Static method in enum class com.couchbase.lite.ProtocolType
- getHeaders() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return Extra HTTP headers to send in all requests to the remote target.
- getHeartbeat() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return the heartbeat interval, in seconds.
- getId() - Method in class com.couchbase.lite.Document
-
return the document's ID.
- getID() - Method in class com.couchbase.lite.ReplicatedDocument
-
The id document of the changed document.
- getIdentity() - Method in class com.couchbase.lite.ClientCertificateAuthenticator
-
Get the client identity.
- getIdentity(String) - Static method in class com.couchbase.lite.TLSIdentity
-
Get a TLSIdentity backed by the information for the passed alias.
- getIndexes() - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().getIndexes
- getIndexes() - Method in class com.couchbase.lite.Collection
-
Get a list of the names of indices in the collection.
- getInfo() - Method in exception com.couchbase.lite.CouchbaseLiteException
- getInt(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as an int.
- getInt(int) - Method in interface com.couchbase.lite.ArrayInterface
- getInt(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as and an int.
- getInt(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as an int.
- getInt(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getInt(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as an int.
- getInt(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as an int Returns 0 if the key doesn't exist or if the value is not a int
- getKeys() - Method in class com.couchbase.lite.Dictionary
- getKeys() - Method in interface com.couchbase.lite.DictionaryInterface
- getKeys() - Method in class com.couchbase.lite.Document
-
Get an List containing all keys, or an empty List if the document has no properties.
- getKeys() - Method in class com.couchbase.lite.Result
- getLanguage() - Method in class com.couchbase.lite.FullTextIndex
- getLanguage() - Method in class com.couchbase.lite.FullTextIndexConfiguration
- getLevel() - Method in class com.couchbase.lite.ConsoleLogger
- getLevel() - Method in class com.couchbase.lite.FileLogger
- getLevel() - Method in interface com.couchbase.lite.Logger
-
Gets the level that will be logged via this logger.
- getLocalC4Replicator(Database) - Method in class com.couchbase.lite.AbstractReplicator
-
Create and return a c4Replicator targeting the passed Database
- getLocalDocument() - Method in class com.couchbase.lite.Conflict
-
The local instance of the document.
- getLong(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as an long.
- getLong(int) - Method in interface com.couchbase.lite.ArrayInterface
- getLong(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as a long.
- getLong(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as an long.
- getLong(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getLong(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as an long.
- getLong(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a long Returns 0L if the key doesn't exist or if the value is not a long
- getMaxAttempts() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return the max number of retry attempts made after connection failure.
- getMaxAttemptWaitTime() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return the max time between retry attempts (exponential backoff).
- getMaxRotateCount() - Method in class com.couchbase.lite.LogFileConfiguration
-
Gets the number of rotated logs that are saved.
- getMaxSize() - Method in class com.couchbase.lite.LogFileConfiguration
-
Gets the max size of the log file in bytes.
- getMessageC4Replicator(MessageFraming) - Method in class com.couchbase.lite.AbstractReplicator
-
Create and return a c4Replicator.
- getMessageFraming() - Method in class com.couchbase.lite.MessageEndpoint
- getName() - Method in class com.couchbase.lite.Database
-
Return the database name
- getName() - Method in class com.couchbase.lite.Collection
-
Return the collection name
- getName() - Method in class com.couchbase.lite.Scope
-
Get the scope name.
- getNetworkInterface() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Get the configured network interface.
- getNumber(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as a Number.
- getNumber(int) - Method in interface com.couchbase.lite.ArrayInterface
- getNumber(int) - Method in class com.couchbase.lite.Result
-
The result at the given index interpreted as a Number.
- getNumber(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as a Number.
- getNumber(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getNumber(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as a Number.
- getNumber(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a Number Returns null if the key doesn't exist or if the value is not a Number
- getOpenC4DbLocked() - Method in class com.couchbase.lite.BaseDatabase
- getParameters() - Method in class com.couchbase.lite.GroupBy
-
Returns a copy of the current parameters.
- getParameters() - Method in interface com.couchbase.lite.Query
-
Returns a copies of the current parameters.
- getPassword() - Method in class com.couchbase.lite.BasicAuthenticator
-
Deprecated.Use
getPasswordChars(char[])
- getPasswordChars() - Method in class com.couchbase.lite.BasicAuthenticator
-
Get the password.
- getPath() - Method in class com.couchbase.lite.Database
-
The database's absolute path
- getPendingDocumentIds() - Method in class com.couchbase.lite.AbstractReplicator
-
Deprecated.Use getPendingDocumentIds(Collection)
- getPendingDocumentIds(Collection) - Method in class com.couchbase.lite.AbstractReplicator
-
Get a best effort list of documents in the passed collection that are still pending replication.
- getPinnedServerCertificate() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use getPinnedServerX509Certificate
- getPinnedServerX509Certificate() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return the remote target's SSL certificate.
- getPort() - Method in class com.couchbase.lite.URLEndpointListener
-
Get the listener's port.
- getPort() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Get the configured port.
- getProgress() - Method in class com.couchbase.lite.ReplicatorStatus
-
The current progress of the replicator.
- getProperties() - Method in class com.couchbase.lite.Blob
-
Get the blob metadata
- getProtocolType() - Method in class com.couchbase.lite.MessageEndpoint
-
Gets the data transportation protocol of the endpoint.
- getProtocolType() - Method in class com.couchbase.lite.MessageEndpointListenerConfiguration
- getPullFilter() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.getPullFilter
- getPullFilter() - Method in class com.couchbase.lite.CollectionConfiguration
-
Gets the filter used to determine whether a document will be pulled from the remote endpoint.
- getPushFilter() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.getPushFilter
- getPushFilter() - Method in class com.couchbase.lite.CollectionConfiguration
-
Gets the filter used to determine whether a document will be pushed to the remote endpoint.
- getQuery() - Method in class com.couchbase.lite.QueryChange
-
Return the source live query object.
- getRemoteC4Replicator(URI) - Method in class com.couchbase.lite.AbstractReplicator
-
Create and return a c4Replicator targeting the passed URI
- getRemoteDocument() - Method in class com.couchbase.lite.Conflict
-
The remote instance of the document.
- getReplicator() - Method in class com.couchbase.lite.DocumentReplication
-
Return the source replicator.
- getReplicator() - Method in class com.couchbase.lite.ReplicatorChange
-
Return the source replicator object.
- getReplicatorType() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use getType()
- getResults() - Method in class com.couchbase.lite.QueryChange
-
Return the new query result.
- getResultSet() - Method in class com.couchbase.lite.ResultContext
- getRevisionID() - Method in class com.couchbase.lite.Document
-
Get the document's revision id.
- getScope() - Method in class com.couchbase.lite.Collection
-
Get scope
- getScope() - Method in class com.couchbase.lite.ReplicatedDocument
-
The scope of the collection to which the changed document belongs.
- getScope(String) - Method in class com.couchbase.lite.Database
-
Get a scope object by name.
- getScopes() - Method in class com.couchbase.lite.Database
-
Get scope names that have at least one collection.
- getSequence() - Method in class com.couchbase.lite.Document
-
Return the sequence number of the document in the database.
- getServerCertificates() - Method in class com.couchbase.lite.AbstractReplicator
-
The server certificates received from the server during the TLS handshake.
- getSessionID() - Method in class com.couchbase.lite.SessionAuthenticator
-
Return session ID of the session created by a Sync Gateway.
- getStatus() - Method in class com.couchbase.lite.AbstractReplicator
-
The replicator's current status: its activity level and progress.
- getStatus() - Method in class com.couchbase.lite.URLEndpointListener
-
Get the listener status.
- getString(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as a String.
- getString(int) - Method in interface com.couchbase.lite.ArrayInterface
- getString(int) - Method in class com.couchbase.lite.Result
-
The result at the given index converted to a String
- getString(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as a String.
- getString(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getString(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as a String.
- getString(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as a String Returns null if the key doesn't exist.
- getTarget() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return the replication target to replicate with.
- getTarget() - Method in class com.couchbase.lite.MessageEndpoint
-
Gets the target object which is an arbitrary object that represents the endpoint.
- getTlsIdentity() - Method in class com.couchbase.lite.URLEndpointListener
-
Get the TLS identity used by the listener.
- getTlsIdentity() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Get the configured TLS identity.
- getTotal() - Method in class com.couchbase.lite.ReplicatorProgress
-
The total number of changes to be processed.
- getType() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return Replicator type indicating the direction of the replicator.
- getUid() - Method in class com.couchbase.lite.MessageEndpoint
-
Gets the unique identifier of the endpoint.
- getURL() - Method in class com.couchbase.lite.URLEndpoint
-
Returns the url.
- getUrls() - Method in class com.couchbase.lite.URLEndpointListener
-
Get the list of URIs for the listener.
- getUsername() - Method in class com.couchbase.lite.BasicAuthenticator
- getValue() - Method in enum class com.couchbase.lite.AbstractIndex.IndexType
- getValue() - Method in enum class com.couchbase.lite.AbstractIndex.QueryLanguage
- getValue() - Method in enum class com.couchbase.lite.ConcurrencyControl
- getValue(int) - Method in class com.couchbase.lite.Array
-
Gets value at the given index as an object.
- getValue(int) - Method in interface com.couchbase.lite.ArrayInterface
- getValue(int) - Method in class com.couchbase.lite.Result
-
The result value at the given index.
- getValue(String) - Method in class com.couchbase.lite.Dictionary
-
Gets a property's value as an object.
- getValue(String) - Method in interface com.couchbase.lite.DictionaryInterface
- getValue(String) - Method in class com.couchbase.lite.Document
-
Gets a property's value as an object.
- getValue(String) - Method in class com.couchbase.lite.Parameters
-
Gets a parameter's value.
- getValue(String) - Method in class com.couchbase.lite.Result
-
The result value for the given key as an Object Returns null if the key doesn't exist.
- greaterThan(Expression) - Method in class com.couchbase.lite.Expression
-
Create a greater than expression that evaluates whether or not the current expression is greater than the given expression.
- greaterThanOrEqualTo(Expression) - Method in class com.couchbase.lite.Expression
-
Create a greater than or equal to expression that evaluates whether or not the current expression is greater than or equal to the given expression.
- groupBy(Expression...) - Method in class com.couchbase.lite.From
-
Creates and chains a GroupBy object to group the query result.
- groupBy(Expression...) - Method in class com.couchbase.lite.Where
-
Create and chain a GROUP BY component to group the query result.
- GroupBy - Class in com.couchbase.lite
-
A GroupBy represents the GROUP BY clause to group the query result.
H
- handle(MutableDocument, Document) - Method in interface com.couchbase.lite.ConflictHandler
- handleOffline(ReplicatorActivityLevel, boolean) - Method in class com.couchbase.lite.AbstractReplicator
- handleOffline(ReplicatorActivityLevel, boolean) - Method in class com.couchbase.lite.Replicator
- hashCode() - Method in class com.couchbase.lite.Database
- hashCode() - Method in class com.couchbase.lite.Array
- hashCode() - Method in class com.couchbase.lite.Blob
-
Get the blob hash code.
- hashCode() - Method in class com.couchbase.lite.Collection
- hashCode() - Method in class com.couchbase.lite.Dictionary
- hashCode() - Method in class com.couchbase.lite.Document
- hashCode() - Method in class com.couchbase.lite.LogFileConfiguration
- hashCode() - Method in class com.couchbase.lite.Scope
- having(Expression) - Method in class com.couchbase.lite.GroupBy
-
Creates and chain a Having object for filtering the aggregated values from the the GROUP BY clause.
- Having - Class in com.couchbase.lite
-
Having represents a HAVING clause of the query statement used for filtering the aggregated values from the the GROUP BY clause.
- HEARTBEAT - Static variable in class com.couchbase.lite.Defaults.Replicator
-
A heartbeat messages is sent every 300 seconds to keep the connection alive
- HTTP_AUTH_REQUIRED - Static variable in class com.couchbase.lite.CBLError.Code
-
Missing or incorrect user authentication
- HTTP_BASE - Static variable in class com.couchbase.lite.CBLError.Code
- HTTP_CONFLICT - Static variable in class com.couchbase.lite.CBLError.Code
-
Update conflict
- HTTP_ENTITY_TOO_LARGE - Static variable in class com.couchbase.lite.CBLError.Code
-
Data is too large to upload
- HTTP_FORBIDDEN - Static variable in class com.couchbase.lite.CBLError.Code
-
User doesn't have permission to access resource
- HTTP_IM_A_TEAPOT - Static variable in class com.couchbase.lite.CBLError.Code
- HTTP_INTERNAL_SERVER_ERROR - Static variable in class com.couchbase.lite.CBLError.Code
-
Something's wrong with the server
- HTTP_NOT_FOUND - Static variable in class com.couchbase.lite.CBLError.Code
-
Resource not found
- HTTP_NOT_IMPLEMENTED - Static variable in class com.couchbase.lite.CBLError.Code
-
Unimplemented server functionality
- HTTP_PROXY_AUTH_REQUIRED - Static variable in class com.couchbase.lite.CBLError.Code
-
HTTP proxy requires authentication
- HTTP_SERVICE_UNAVAILABLE - Static variable in class com.couchbase.lite.CBLError.Code
-
Service is down temporarily
I
- id - Static variable in class com.couchbase.lite.Meta
-
A metadata expression referring to the ID of the document.
- IDLE - Enum constant in enum class com.couchbase.lite.ReplicatorActivityLevel
-
The replication is inactive; either waiting for changes or offline as the remote host is unreachable.
- IGNORE_ACCENTS - Static variable in class com.couchbase.lite.Defaults.FullTextIndex
-
Accents and ligatures are not ignored when indexing via full text search
- ignoreAccents(boolean) - Method in class com.couchbase.lite.FullTextIndex
-
Set true to ignore accents/diacritical marks.
- ignoreAccents(boolean) - Method in class com.couchbase.lite.FullTextIndexConfiguration
-
Set the true value to ignore accents/diacritical marks.
- importEntry(String, InputStream, char[], String, char[], String) - Static method in class com.couchbase.lite.KeyStoreUtils
-
Imports the key entry including public key, private key, and certificates from the given KeyStore input stream into the Android KeyStore.
- in(Expression) - Method in class com.couchbase.lite.ArrayExpressionIn
-
Creates a Satisfies clause object with the given IN clause expression that could be an array object or an expression evaluated as an array object.
- in(Expression...) - Method in class com.couchbase.lite.Expression
-
Create an IN expression that evaluates whether or not the current expression is in the given expressions.
- inBatch(UnitOfWork<T>) - Method in class com.couchbase.lite.Database
-
Runs a group of database operations in a batch.
- index(String) - Static method in class com.couchbase.lite.FullTextExpression
-
Deprecated.Use FullTextFunction.match()
- Index - Class in com.couchbase.lite
-
Index represents an index: either a value index for regular queries or full-text index for full-text queries (using the match operator).
- IndexBuilder - Class in com.couchbase.lite
-
IndexBuilder used for building database indices.
- IndexConfiguration - Class in com.couchbase.lite
- IndexExpression - Interface in com.couchbase.lite
- indexItems - Variable in class com.couchbase.lite.ValueIndex
- INFO - Enum constant in enum class com.couchbase.lite.LogLevel
-
Essential state info and client errors that are recoverable
- init(Context) - Static method in class com.couchbase.lite.CouchbaseLite
-
Initialize CouchbaseLite library.
- init(Context, boolean) - Static method in class com.couchbase.lite.CouchbaseLite
-
Initialize CouchbaseLite library.
- init(Context, boolean, File, File) - Static method in class com.couchbase.lite.CouchbaseLite
-
Initialize CouchbaseLite library.
- innerJoin(DataSource) - Static method in class com.couchbase.lite.Join
-
Create an INNER JOIN component with the given data source.
- insertArray(int, Array) - Method in class com.couchbase.lite.MutableArray
-
Inserts an Array object at the given index.
- insertBlob(int, Blob) - Method in class com.couchbase.lite.MutableArray
-
Inserts a Blob object at the given index.
- insertBoolean(int, boolean) - Method in class com.couchbase.lite.MutableArray
-
Inserts a boolean value at the given index.
- insertDate(int, Date) - Method in class com.couchbase.lite.MutableArray
-
Inserts a Date object at the given index.
- insertDictionary(int, Dictionary) - Method in class com.couchbase.lite.MutableArray
-
Inserts a Dictionary object at the given index.
- insertDouble(int, double) - Method in class com.couchbase.lite.MutableArray
-
Inserts a double value at the given index.
- insertFloat(int, float) - Method in class com.couchbase.lite.MutableArray
-
Inserts a float value at the given index.
- insertInt(int, int) - Method in class com.couchbase.lite.MutableArray
-
Inserts an integer value at the given index.
- insertLong(int, long) - Method in class com.couchbase.lite.MutableArray
-
Inserts a long value at the given index.
- insertNumber(int, Number) - Method in class com.couchbase.lite.MutableArray
-
Inserts a Number object at the given index.
- insertString(int, String) - Method in class com.couchbase.lite.MutableArray
-
Inserts a String object at the given index.
- insertValue(int, Object) - Method in class com.couchbase.lite.MutableArray
-
Inserts an object at the given index.
- INTEGRITY_CHECK - Enum constant in enum class com.couchbase.lite.MaintenanceType
-
Checks for database corruption, as might be caused by a damaged filesystem, or memory corruption.
- internalArray - Variable in class com.couchbase.lite.Array
- internalDict - Variable in class com.couchbase.lite.Dictionary
- intValue(int) - Static method in class com.couchbase.lite.Expression
-
Create value expression with given integer value
- INVALID_PARAMETER - Static variable in class com.couchbase.lite.CBLError.Code
-
Invalid function parameter or struct value
- INVALID_QUERY - Static variable in class com.couchbase.lite.CBLError.Code
-
Invalid query
- INVALID_QUERY_PARAM - Static variable in class com.couchbase.lite.CBLError.Code
-
Unknown query param name, or param number out of range
- INVALID_REDIRECT - Static variable in class com.couchbase.lite.CBLError.Code
-
The client was redirected to an invalid location by the server
- INVALID_URL - Static variable in class com.couchbase.lite.CBLError.Code
-
The provided URL is not valid
- IO_ERROR - Static variable in class com.couchbase.lite.CBLError.Code
-
File I/O error
- is(Expression) - Method in class com.couchbase.lite.Expression
-
Create an IS expression that evaluates whether or not the current expression is equal to the given expression.
- isAcceptOnlySelfSignedServerCertificate() - Method in class com.couchbase.lite.ReplicatorConfiguration
-
ENTERPRISE EDITION API
- isAcceptParentDomainCookies() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
The option to remove a restriction that does not allow a replicator to accept cookies from a remote host unless the cookie domain exactly matches the the domain of the sender.
- isAutoPurgeEnabled() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Enable/disable auto-purge.
- isBlob(Map<String, ?>) - Static method in class com.couchbase.lite.Blob
- isClosed() - Method in class com.couchbase.lite.ResultContext
- isContinuous() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Return the continuous flag indicating whether the replicator should stay active indefinitely to replicate changed documents.
- isDeltaSyncEnabled() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Is delta sync enabled.
- isDocumentPending(String) - Method in class com.couchbase.lite.AbstractReplicator
-
Deprecated.Use isDocumentPending(String, Collection)
- isDocumentPending(String, Collection) - Method in class com.couchbase.lite.AbstractReplicator
-
Best effort check to see if the document whose ID is passed is still pending replication.
- isEmpty() - Method in class com.couchbase.lite.Dictionary
- isFullSync() - Method in class com.couchbase.lite.DatabaseConfiguration
- isIgnoringAccents() - Method in class com.couchbase.lite.FullTextIndex
- isIgnoringAccents() - Method in class com.couchbase.lite.FullTextIndexConfiguration
- isNot(Expression) - Method in class com.couchbase.lite.Expression
-
Create an IS NOT expression that evaluates whether or not the current expression is not equal to the given expression.
- isNotValued() - Method in class com.couchbase.lite.Expression
-
Creates an IS NOT VALUED expression that returns true if the current expression is NOT VALUED.
- isNullOrMissing() - Method in class com.couchbase.lite.Expression
-
Deprecated.Use Expression.isNotValued
- isOpen() - Method in class com.couchbase.lite.BaseDatabase
- isOpenLocked() - Method in class com.couchbase.lite.BaseDatabase
- isPush() - Method in class com.couchbase.lite.DocumentReplication
-
The direction of replication for the affected documents.
- isReadOnly() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Is connection read-only.
- isRecoverable() - Method in class com.couchbase.lite.MessagingError
-
Is the error recoverable?
- isTlsDisabled() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Get configured connection type.
- isValued() - Method in class com.couchbase.lite.Expression
-
Creates an IS VALUED expression that returns true if the current expression is valued.
- iterator() - Method in class com.couchbase.lite.Array
-
An iterator over elements of this array.
- iterator() - Method in class com.couchbase.lite.Dictionary
-
An iterator over keys of this Dictionary.
- iterator() - Method in class com.couchbase.lite.Document
-
Gets an iterator over the keys of the document's properties
- iterator() - Method in class com.couchbase.lite.Result
-
Gets an iterator over the result's keys.
- iterator() - Method in class com.couchbase.lite.ResultSet
-
Return Iterator of Results.
J
- join(DataSource) - Static method in class com.couchbase.lite.Join
-
Create a JOIN (same as INNER JOIN) component with the given data source.
- join(Join...) - Method in class com.couchbase.lite.From
-
Creates and chains a Joins object for specifying the JOIN clause of the query.
- Join - Class in com.couchbase.lite
-
A Join component representing a single JOIN clause in the query statement.
- Join.On - Class in com.couchbase.lite
-
Component used for specifying join on conditions.
- Joins - Class in com.couchbase.lite
-
A Joins component represents a collection of the joins clauses of the query statement.
- JSON - Enum constant in enum class com.couchbase.lite.AbstractIndex.QueryLanguage
K
- KeyStoreUtils - Class in com.couchbase.lite
-
Key Store Utilities
L
- LAST_WRITE_WINS - Enum constant in enum class com.couchbase.lite.ConcurrencyControl
-
The last write operation will win if there is a conflict.
- leftJoin(DataSource) - Static method in class com.couchbase.lite.Join
-
Create a LEFT JOIN (same as LEFT OUTER JOIN) component with the given data source.
- leftOuterJoin(DataSource) - Static method in class com.couchbase.lite.Join
-
Create a LEFT OUTER JOIN component with the given data source.
- length() - Method in class com.couchbase.lite.Blob
-
The number of byte of content this blob contains.
- length(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a LENGTH(expr) function that returns the length of the given string expression.
- length(Expression) - Static method in class com.couchbase.lite.ArrayFunction
-
Creates an ARRAY_LENGTH(expr) function that returns the length of the given array expression.
- lessThan(Expression) - Method in class com.couchbase.lite.Expression
-
Create a less than expression that evaluates whether or not the current expression is less than the given expression.
- lessThanOrEqualTo(Expression) - Method in class com.couchbase.lite.Expression
-
Create a less than or equal to expression that evaluates whether or not the current expression is less than or equal to the given expression.
- like(Expression) - Method in class com.couchbase.lite.Expression
-
Create a Like expression that evaluates whether or not the current expression is LIKE the given expression.
- limit(Expression) - Method in class com.couchbase.lite.From
-
Creates and chains a Limit object to limit the number query results.
- limit(Expression) - Method in class com.couchbase.lite.GroupBy
-
Creates and chains a Limit object to limit the number query results.
- limit(Expression) - Method in class com.couchbase.lite.Having
-
Creates and chains a Limit object to limit the number query results.
- limit(Expression) - Method in class com.couchbase.lite.Joins
-
Creates and chains a Limit object to limit the number query results.
- limit(Expression) - Method in class com.couchbase.lite.OrderBy
-
Creates and chains a Limit object to limit the number query results.
- limit(Expression) - Method in class com.couchbase.lite.Where
-
Create and chain a LIMIT component to limit the number query results.
- limit(Expression, Expression) - Method in class com.couchbase.lite.From
-
Creates and chains a Limit object to skip the returned results for the given offset position and to limit the number of results to not more than the given limit value.
- limit(Expression, Expression) - Method in class com.couchbase.lite.GroupBy
-
Creates and chains a Limit object to skip the returned results for the given offset position and to limit the number of results to not more than the given limit value.
- limit(Expression, Expression) - Method in class com.couchbase.lite.Having
-
Creates and chains a Limit object to skip the returned results for the given offset position and to limit the number of results to not more than the given limit value.
- limit(Expression, Expression) - Method in class com.couchbase.lite.Joins
-
Creates and chains a Limit object to skip the returned results for the given offset position and to limit the number of results to not more than the given limit value.
- limit(Expression, Expression) - Method in class com.couchbase.lite.OrderBy
-
Creates and chains a Limit object to skip the returned results for the given offset
- limit(Expression, Expression) - Method in class com.couchbase.lite.Where
-
Create and chain a LIMIT component to skip the returned results for the given offset position and to limit the number of results to not more than the given limit value.
- Limit - Class in com.couchbase.lite
-
A Limit component represents the LIMIT clause of the query statement.
- list(List<Object>) - Static method in class com.couchbase.lite.Expression
-
Create value expression with the given list.
- LISTENER - Enum constant in enum class com.couchbase.lite.LogDomain
- ListenerAuthenticator - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
Opaque interface for the authenticator used by a URLEndpointListener - ListenerCertificateAuthenticator - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
A Listener Certificate Authenticator. - ListenerCertificateAuthenticator(ListenerCertificateAuthenticatorDelegate) - Constructor for class com.couchbase.lite.ListenerCertificateAuthenticator
-
Create an authenticator that delegates all responsibility for authentication and authorization to the passed delegate.
- ListenerCertificateAuthenticator(List<Certificate>) - Constructor for class com.couchbase.lite.ListenerCertificateAuthenticator
-
Create an authenticator that allows clients whose certificate chains can be verified using (only) one of the certs in the passed list.
- ListenerCertificateAuthenticatorDelegate - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
Functional Interface for an Authenticator that uses an authentication strategy based on client supplied certificates. - ListenerPasswordAuthenticator - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
Authenticator for HTTP Listener password authentication - ListenerPasswordAuthenticator(ListenerPasswordAuthenticatorDelegate) - Constructor for class com.couchbase.lite.ListenerPasswordAuthenticator
-
Create an Authenticator using the passed delegate.
- ListenerPasswordAuthenticatorDelegate - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
Functional Interface for an Authenticator that uses an authentication strategy based on a user name and password. - ListenerToken - Class in com.couchbase.lite
-
Base class for a removable subscription to an observable.
- ListenerToken(Executor, Fn.Consumer<ListenerToken>) - Constructor for class com.couchbase.lite.ListenerToken
- LiteCoreException - Exception in com.couchbase.lite
-
Internal error in native code.
- LiteCoreException(int, int, String) - Constructor for exception com.couchbase.lite.LiteCoreException
- ln(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a LN(expr) function that returns the natural log of the given numeric expression.
- lock - Variable in class com.couchbase.lite.Array
- lock - Variable in class com.couchbase.lite.Dictionary
- log - Static variable in class com.couchbase.lite.Database
-
Gets the logging controller for the Couchbase Lite library to configure the logging settings and add custom logging.
- log(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a LOG(expr) function that returns the base 10 log of the given numeric expression.
- log(LogLevel, LogDomain, String) - Method in class com.couchbase.lite.ConsoleLogger
- log(LogLevel, LogDomain, String) - Method in class com.couchbase.lite.FileLogger
- log(LogLevel, LogDomain, String) - Method in interface com.couchbase.lite.Logger
-
Performs the actual logging logic
- Log - Class in com.couchbase.lite
-
Holder for the three Couchbase Lite loggers: console, file, and custom.
- LogDomain - Enum Class in com.couchbase.lite
-
Log domain
- LogFileConfiguration - Class in com.couchbase.lite
-
A class that describes the file configuration for the
FileLogger
class. - LogFileConfiguration(LogFileConfiguration) - Constructor for class com.couchbase.lite.LogFileConfiguration
-
Constructs a file configuration object based on another one so that it may be modified
- LogFileConfiguration(String) - Constructor for class com.couchbase.lite.LogFileConfiguration
-
Constructs a file configuration object with the given directory
- LogFileConfiguration(String, LogFileConfiguration) - Constructor for class com.couchbase.lite.LogFileConfiguration
-
Constructs a file configuration object based on another one but changing the directory
- Logger - Interface in com.couchbase.lite
-
The logging interface for Couchbase Lite.
- LogLevel - Enum Class in com.couchbase.lite
-
Log level.
- longValue(long) - Static method in class com.couchbase.lite.Expression
-
Create value expression with given long value
- lower(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a LOWER(expr) function that returns the lowercase string of the given string expression.
- ltrim(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a LTRIM(expr) function that removes the whitespace from the beginning of the given string expression.
M
- MaintenanceType - Enum Class in com.couchbase.lite
- map(Map<String, Object>) - Static method in class com.couchbase.lite.Expression
-
Creates value expression with the given map.
- match(IndexExpression, String) - Static method in class com.couchbase.lite.FullTextFunction
-
Creates a full-text match() function with the given full-text index expression and the query text
- match(String) - Method in class com.couchbase.lite.FullTextExpression
-
Deprecated.Use FullTextFunction.match()
- match(String, String) - Static method in class com.couchbase.lite.FullTextFunction
-
Deprecated.Use: FullTextFunction.match(IndexExpression)
- max(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a MAX(expr) function expression that returns the maximum value in the group of the values expressed by the given expression.
- MAX_ATTEMPT_WAIT_TIME - Static variable in class com.couchbase.lite.Defaults.Replicator
-
Max wait time between retry attempts in seconds
- MAX_ATTEMPTS_CONTINUOUS - Static variable in class com.couchbase.lite.Defaults.Replicator
-
When replicator is continuous, never give up unless explicitly stopped
- MAX_ATTEMPTS_SINGLE_SHOT - Static variable in class com.couchbase.lite.Defaults.Replicator
-
When replicator is not continuous, after 10 failed attempts give up on the replication
- MAX_PORT - Static variable in class com.couchbase.lite.URLEndpointListenerConfiguration
- MAX_ROTATE_COUNT - Static variable in class com.couchbase.lite.Defaults.LogFile
-
1 rotated file present (2 total, including the currently active log file)
- MAX_SIZE - Static variable in class com.couchbase.lite.Defaults.LogFile
-
512 KiB for the size of a log file
- MEMORY_ERROR - Static variable in class com.couchbase.lite.CBLError.Code
-
Memory allocation failed (out of memory?)
- Message - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- MESSAGE_STREAM - Enum constant in enum class com.couchbase.lite.ProtocolType
- MessageEndpoint - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessageEndpoint(String, Object, ProtocolType, MessageEndpointDelegate) - Constructor for class com.couchbase.lite.MessageEndpoint
-
Initializes a CBLMessageEndpoint object.
- MessageEndpointConnection - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessageEndpointDelegate - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessageEndpointListener - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessageEndpointListener(MessageEndpointListenerConfiguration) - Constructor for class com.couchbase.lite.MessageEndpointListener
- MessageEndpointListenerChange - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessageEndpointListenerChangeListener - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessageEndpointListenerConfiguration - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessageEndpointListenerConfiguration(Database, ProtocolType) - Constructor for class com.couchbase.lite.MessageEndpointListenerConfiguration
-
Deprecated.Use MessageEndpointListener(Collection, ProtocolType)
- MessageEndpointListenerConfiguration(Set<Collection>, ProtocolType) - Constructor for class com.couchbase.lite.MessageEndpointListenerConfiguration
-
Create a MessageEndpointListenerConfiguration with the passed protocol type, for the passed Collections The passed set must contain at least one collection and all of the collections it contains must belong to the same scope and the same database, otherwise an InvalidArgumentException will be thrown.
- MessagingCloseCompletion - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessagingCompletion - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessagingError - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- MessagingError(Exception, boolean) - Constructor for class com.couchbase.lite.MessagingError
-
Creates a MessagingError with the given error and recoverable flag identifying if the error is recoverable or not.
- Meta - Class in com.couchbase.lite
-
Meta is a factory class for creating the expressions that refer to the metadata properties of the document.
- MetaExpression - Class in com.couchbase.lite
-
A meta property expression.
- millisToString(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a MILLIS_TO_STR(expr) function that will convert a numeric input representing milliseconds since the Unix epoch into a full ISO8601 date and time string in the device local time zone.
- millisToUTC(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a MILLIS_TO_UTC(expr) function that will convert a numeric input representing milliseconds since the Unix epoch into a full ISO8601 date and time string in UTC time.
- min(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a MIN(expr) function expression that returns the minimum value in the group of the values expressed by the given expression.
- MIN_PORT - Static variable in class com.couchbase.lite.URLEndpointListenerConfiguration
- MISSING_INDEX - Static variable in class com.couchbase.lite.CBLError.Code
-
No such index, or query requires a nonexistent index
- modulo(Expression) - Method in class com.couchbase.lite.Expression
-
Create a modulo expression to modulo the current expression by the given expression.
- multiply(Expression) - Method in class com.couchbase.lite.Expression
-
Create a multiply expression to multiply the current expression by the given expression.
- MutableArray - Class in com.couchbase.lite
-
Mutable access to array data.
- MutableArray() - Constructor for class com.couchbase.lite.MutableArray
-
Construct a new empty Array object.
- MutableArray(String) - Constructor for class com.couchbase.lite.MutableArray
-
Creates a new MutableArray with content from the passed JSON string.
- MutableArray(List<Object>) - Constructor for class com.couchbase.lite.MutableArray
-
Creates a new MutableArray with content from the passed List.
- MutableDictionary - Class in com.couchbase.lite
-
Mutable access to dictionary data.
- MutableDictionary() - Constructor for class com.couchbase.lite.MutableDictionary
-
Construct a new empty Dictionary object.
- MutableDictionary(String) - Constructor for class com.couchbase.lite.MutableDictionary
-
Creates a new MutableDictionary with content from the passed JSON string.
- MutableDictionary(Map<String, Object>) - Constructor for class com.couchbase.lite.MutableDictionary
-
Creates a new MutableDictionary with content from the passed Map.
- MutableDictionaryInterface - Interface in com.couchbase.lite
-
This is an internal interface and not part of the public API.
- MutableDocument - Class in com.couchbase.lite
-
A Couchbase Lite Document.
- MutableDocument() - Constructor for class com.couchbase.lite.MutableDocument
-
Creates a new Document object with a new random UUID.
- MutableDocument(String) - Constructor for class com.couchbase.lite.MutableDocument
-
Creates a new Document with the given ID.
- MutableDocument(String, String) - Constructor for class com.couchbase.lite.MutableDocument
-
Creates a new Document with the given ID and content from the passed JSON string.
- MutableDocument(String, Map<String, Object>) - Constructor for class com.couchbase.lite.MutableDocument
-
Creates a new Document with a given ID and content from the passed Map.
- MutableDocument(Map<String, Object>) - Constructor for class com.couchbase.lite.MutableDocument
-
Creates a new Document with a new random UUID and the map as the content.
- MValueConverter - Class in com.couchbase.lite
-
This class exists to provide access to package visible symbols, to MValue
- MValueConverter() - Constructor for class com.couchbase.lite.MValueConverter
N
- N1QL - Enum constant in enum class com.couchbase.lite.AbstractIndex.QueryLanguage
- negated(Expression) - Static method in class com.couchbase.lite.Expression
-
Create a negated expression to represent the negated result of the given expression.
- NETWORK - Enum constant in enum class com.couchbase.lite.LogDomain
- NETWORK_OFFSET - Static variable in class com.couchbase.lite.CBLError.Code
- next() - Method in class com.couchbase.lite.ResultSet
-
Move the cursor forward one row from its current row position.
- NONE - Enum constant in enum class com.couchbase.lite.LogLevel
-
Disabling log messages of a given log domain.
- not(Expression) - Static method in class com.couchbase.lite.Expression
-
Create a negated expression to represent the negated result of the given expression.
- NOT_A_DATABASE_FILE - Static variable in class com.couchbase.lite.CBLError.Code
- NOT_FOUND - Static variable in class com.couchbase.lite.CBLError.Code
-
Document not found
- NOT_IN_TRANSACTION - Static variable in class com.couchbase.lite.CBLError.Code
-
Function cannot be called while in a transaction
- NOT_OPEN - Static variable in class com.couchbase.lite.CBLError.Code
-
Database/KeyStore is not open
- NOT_WRITABLE - Static variable in class com.couchbase.lite.CBLError.Code
-
File is not writeable
- notEqualTo(Expression) - Method in class com.couchbase.lite.Expression
-
Create a NOT equal to expression that evaluates whether or not the current expression is not equal to the given expression.
- notNullOrMissing() - Method in class com.couchbase.lite.Expression
-
Deprecated.Use Expression.isValued
- number(Number) - Static method in class com.couchbase.lite.Expression
-
Create value expression with given Number value
O
- OFFLINE - Enum constant in enum class com.couchbase.lite.ReplicatorActivityLevel
-
The replicator is offline because the remote host is unreachable.
- on(Expression) - Method in class com.couchbase.lite.Join.On
-
Specify join conditions from the given expression.
- open(ReplicatorConnection, MessagingCompletion) - Method in interface com.couchbase.lite.MessageEndpointConnection
-
Called to open a remote connection to the other peer when the replicator starts or when the MessageEndpointListener accepts the connection.
- OPTIMIZE - Enum constant in enum class com.couchbase.lite.MaintenanceType
-
Quickly updates database statistics that may help optimize queries that have been run by this Database since it was opened.
- or(Expression) - Method in class com.couchbase.lite.Expression
-
Create a logical OR expression that performs logical OR operation with the current expression.
- orderBy(Ordering...) - Method in class com.couchbase.lite.From
-
Create and chain an ORDER BY component for specifying the ORDER BY clause of the query.
- orderBy(Ordering...) - Method in class com.couchbase.lite.GroupBy
-
Create and chain an ORDER BY component for specifying the ORDER BY clause of the query.
- orderBy(Ordering...) - Method in class com.couchbase.lite.Having
-
Create and chain an ORDER BY component for specifying the orderings of the query result.
- orderBy(Ordering...) - Method in class com.couchbase.lite.Joins
-
Creates and chains an OrderBy object for specifying the orderings of the query result.
- orderBy(Ordering...) - Method in class com.couchbase.lite.Where
-
Create and chain an ORDER BY component for specifying the ORDER BY clause of the query.
- OrderBy - Class in com.couchbase.lite
-
An OrderBy represents an ORDER BY clause of the query for specifying properties or expressions that the result rows should be sorted by.
- Ordering - Class in com.couchbase.lite
-
An Ordering represents a single ordering component in the query ORDER BY clause.
- Ordering() - Constructor for class com.couchbase.lite.Ordering
- Ordering.SortOrder - Class in com.couchbase.lite
-
SortOrder represents a single ORDER BY entity.
P
- parameter(String) - Static method in class com.couchbase.lite.Expression
-
Creates a parameter expression with the given parameter name.
- Parameters - Class in com.couchbase.lite
-
A Parameters object used for setting values to the query parameters defined in the query.
- Parameters() - Constructor for class com.couchbase.lite.Parameters
- Parameters(Parameters) - Constructor for class com.couchbase.lite.Parameters
- performMaintenance(MaintenanceType) - Method in class com.couchbase.lite.Database
- pi() - Static method in class com.couchbase.lite.Function
-
Creates a PI() function that returns the mathematical constant Pi.
- PORT - Static variable in class com.couchbase.lite.Defaults.Listener
-
No port specified, the OS will assign one
- POSIX - Static variable in class com.couchbase.lite.CBLError.Domain
- power(Expression, Expression) - Static method in class com.couchbase.lite.Function
-
Creates a POWER(base, exponent) function that returns the value of the given base expression power the given exponent expression.
- predict(Dictionary) - Method in interface com.couchbase.lite.PredictiveModel
-
The prediction callback called when invoking the Function.prediction() function inside a query or an index.
- prediction - Static variable in class com.couchbase.lite.Database
-
ENTERPRISE EDITION API
- prediction(String, Expression) - Static method in class com.couchbase.lite.Function
-
ENTERPRISE EDITION API
- Prediction - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- PredictionFunction - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- PREDICTIVE - Enum constant in enum class com.couchbase.lite.AbstractIndex.IndexType
- predictiveIndex(String, Expression, List<String>) - Static method in class com.couchbase.lite.IndexBuilder
-
ENTERPRISE EDITION API
- PredictiveIndex - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- PredictiveModel - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
- prepQueryLocked(AbstractDatabase) - Method in class com.couchbase.lite.GroupBy
- property(String) - Static method in class com.couchbase.lite.Expression
-
Create a property expression representing the value of the given property.
- property(String) - Static method in class com.couchbase.lite.FullTextIndexItem
-
Creates a full-text search index item with the given property.
- property(String) - Static method in class com.couchbase.lite.Ordering
-
Create a SortOrder, inherited from the OrderBy class, object by the given property name.
- property(String) - Static method in class com.couchbase.lite.SelectResult
-
Creates a SelectResult with the given property name.
- property(String) - Static method in class com.couchbase.lite.ValueIndexItem
-
Creates a value index item with the given property.
- PropertyExpression - Class in com.couchbase.lite
-
Property expression
- propertyPath(String) - Method in class com.couchbase.lite.PredictionFunction
-
Creates a property expression that refers to a property of the prediction result dictionary.
- ProtocolType - Enum Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- PULL - Enum constant in enum class com.couchbase.lite.AbstractReplicatorConfiguration.ReplicatorType
-
Deprecated.
- PULL - Enum constant in enum class com.couchbase.lite.ReplicatorType
- purge(Document) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().purge
- purge(Document) - Method in class com.couchbase.lite.Collection
-
When purging a document, the collection instance of the document and this collection instance must be the same, otherwise, the InvalidParameter error will be thrown.
- purge(String) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().purge
- purge(String) - Method in class com.couchbase.lite.Collection
-
Purge a document by id from the collection.
- PUSH - Enum constant in enum class com.couchbase.lite.AbstractReplicatorConfiguration.ReplicatorType
-
Deprecated.
- PUSH - Enum constant in enum class com.couchbase.lite.ReplicatorType
- PUSH_AND_PULL - Enum constant in enum class com.couchbase.lite.AbstractReplicatorConfiguration.ReplicatorType
-
Deprecated.
- PUSH_AND_PULL - Enum constant in enum class com.couchbase.lite.ReplicatorType
Q
- Query - Interface in com.couchbase.lite
-
A database query built using the fluent interface in
QueryBuilder
. - QUERY - Enum constant in enum class com.couchbase.lite.LogDomain
- QueryBuilder - Class in com.couchbase.lite
- QueryChange - Class in com.couchbase.lite
-
Information about changes in a query result changes, reported by a live query.
- QueryChangeListener - Interface in com.couchbase.lite
-
The listener interface for receiving Live Query change events.
R
- radians(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a RADIANS(expr) function that returns the radians value of the given degrees value expression.
- rank(IndexExpression) - Static method in class com.couchbase.lite.FullTextFunction
-
Creates a full-text rank function with the given full-text index expression.
- rank(String) - Static method in class com.couchbase.lite.FullTextFunction
-
Deprecated.Use: FullTextFunction.rank(IndexExpression)
- rawValue() - Method in enum class com.couchbase.lite.DocumentFlag
- READ_ONLY - Static variable in class com.couchbase.lite.Defaults.Listener
-
The listener will allow database writes
- receive(Message) - Method in interface com.couchbase.lite.ReplicatorConnection
-
Tells the replicator to consume the data received from the other peer.
- regex(Expression) - Method in class com.couchbase.lite.Expression
-
Create a regex match expression that evaluates whether or not the current expression regex matches the given expression.
- registerModel(String, PredictiveModel) - Method in class com.couchbase.lite.Prediction
-
Register a predictive model by the given name.
- REINDEX - Enum constant in enum class com.couchbase.lite.MaintenanceType
-
Use only in collaboration with Couchbase Support.
- REMOTE_ERROR - Static variable in class com.couchbase.lite.CBLError.Code
-
Unknown error from remote server
- remove() - Method in class com.couchbase.lite.ListenerToken
- remove(int) - Method in class com.couchbase.lite.MutableArray
-
Removes the object at the given index.
- remove(String) - Method in class com.couchbase.lite.MutableDictionary
-
Removes the mapping for a key from this Dictionary
- remove(String) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- remove(String) - Method in class com.couchbase.lite.MutableDocument
-
Removes the mapping for a key from this Dictionary
- removeChangeListener(ListenerToken) - Method in class com.couchbase.lite.Database
-
Deprecated.Use ListenerToken.remove
- removeChangeListener(ListenerToken) - Method in class com.couchbase.lite.GroupBy
-
Deprecated.use ListenerToken.remove()
- removeChangeListener(ListenerToken) - Method in class com.couchbase.lite.AbstractReplicator
-
Deprecated.use ListenerToken.remove
- removeChangeListener(ListenerToken) - Method in class com.couchbase.lite.MessageEndpointListener
-
Deprecated.use ListenerToken.remove
- removeChangeListener(ListenerToken) - Method in interface com.couchbase.lite.Query
-
Deprecated.Use ListenerToken.remove()
- removeCollection(Collection) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Remove a collection from the replication.
- ReplicatedDocument - Class in com.couchbase.lite
-
Information about a Document updated by replication.
- replication(DocumentReplication) - Method in interface com.couchbase.lite.DocumentReplicationListener
-
The callback function from Replicator
- ReplicationFilter - Interface in com.couchbase.lite
-
Delegate that takes Document input parameter and bool output parameter Document push and pull will be allowed if the predicate returns true.
- Replicator - Class in com.couchbase.lite
- Replicator(ReplicatorConfiguration) - Constructor for class com.couchbase.lite.Replicator
-
Initializes a replicator with the given configuration.
- REPLICATOR - Enum constant in enum class com.couchbase.lite.LogDomain
- ReplicatorActivityLevel - Enum Class in com.couchbase.lite
-
Activity level of a replicator.
- ReplicatorChange - Class in com.couchbase.lite
-
ReplicatorChange contains the replicator status information.
- ReplicatorChangeListener - Interface in com.couchbase.lite
-
The listener interface for receiving Replicator change events.
- ReplicatorConfiguration - Class in com.couchbase.lite
-
Configuration for a Replicator
- ReplicatorConfiguration(Database, Endpoint) - Constructor for class com.couchbase.lite.ReplicatorConfiguration
-
Deprecated.Use ReplicatorConfiguration(Endpoint)
- ReplicatorConfiguration(Endpoint) - Constructor for class com.couchbase.lite.ReplicatorConfiguration
-
Create a Replicator Configuration
- ReplicatorConfiguration(ReplicatorConfiguration) - Constructor for class com.couchbase.lite.ReplicatorConfiguration
-
Copy a Replicator Configuration
- ReplicatorConnection - Interface in com.couchbase.lite
-
ENTERPRISE EDITION API
- ReplicatorProgress - Class in com.couchbase.lite
-
Progress of a replicator.
- ReplicatorStatus - Class in com.couchbase.lite
-
The activity level and progress of a replicator.
- ReplicatorType - Enum Class in com.couchbase.lite
-
The replication direction
- resolve(Conflict) - Method in interface com.couchbase.lite.ConflictResolver
-
Callback: called when there are conflicting changes in the local and remote versions of a document during replication.
- Result - Class in com.couchbase.lite
-
Result represents a row of result set returned by a Query.
- ResultContext - Class in com.couchbase.lite
- ResultContext(AbstractDatabase, ResultSet) - Constructor for class com.couchbase.lite.ResultContext
- ResultSet - Class in com.couchbase.lite
-
The representation of a query result.
- revisionID - Static variable in class com.couchbase.lite.Meta
-
A metadata expression referring to the RevisionId of the document.
- round(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a ROUND(expr) function that returns the rounded value of the given numeric expression.
- round(Expression, Expression) - Static method in class com.couchbase.lite.Function
-
Creates a ROUND(expr, digits) function that returns the rounded value to the given number of digits of the given numeric expression.
- rtrim(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a RTRIM(expr) function that removes the whitespace from the end of the given string expression.
- run() - Method in interface com.couchbase.lite.UnitOfWork
S
- satisfies(Expression) - Method in class com.couchbase.lite.ArrayExpressionSatisfies
-
Creates a complete quantified operator with the given satisfies expression.
- save(MutableDocument) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().save
- save(MutableDocument) - Method in class com.couchbase.lite.Collection
-
Save a document into the collection.
- save(MutableDocument, ConcurrencyControl) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().save()
- save(MutableDocument, ConcurrencyControl) - Method in class com.couchbase.lite.Collection
-
Save a document into the collection with a specified concurrency control.
- save(MutableDocument, ConflictHandler) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().save
- save(MutableDocument, ConflictHandler) - Method in class com.couchbase.lite.Collection
-
Save a document into the collection with a specified conflict handler.
- saveBlob(Blob) - Method in class com.couchbase.lite.Database
-
(UNCOMMITTED) Use this API if you are developing Javascript language bindings.
- Scope - Class in com.couchbase.lite
- select(SelectResult...) - Static method in class com.couchbase.lite.QueryBuilder
-
Create a SELECT statement instance that you can use further (e.g.
- Select - Class in com.couchbase.lite
-
Select represents the SELECT clause of the query for specifying the properties in each query result row.
- selectDistinct(SelectResult...) - Static method in class com.couchbase.lite.QueryBuilder
-
Create a SELECT DISTINCT statement instance that you can use further (e.g.
- SelectResult - Class in com.couchbase.lite
-
SelectResult represents the result of a query.
- SelectResult(Expression) - Constructor for class com.couchbase.lite.SelectResult
- SelectResult.As - Class in com.couchbase.lite
-
SelectResult.As is a SelectResult with an alias.
- SelectResult.From - Class in com.couchbase.lite
-
SelectResult.From is a SelectResult for which you can specify a data source alias.
- SELF_SIGNED_CERTIFICATE_ONLY - Static variable in class com.couchbase.lite.Defaults.Replicator
-
Whether or not a replicator only accepts self-signed certificates from the remote
- send(Message, MessagingCompletion) - Method in interface com.couchbase.lite.MessageEndpointConnection
-
Called to send the replication data to the other peer.
- send(Runnable) - Method in class com.couchbase.lite.ListenerToken
- sequence - Static variable in class com.couchbase.lite.Meta
-
A metadata expression referring to the sequence number of the document.
- SessionAuthenticator - Class in com.couchbase.lite
-
SessionAuthenticator class is an authenticator that will authenticate by using the session ID of the session created by a Sync Gateway
- SessionAuthenticator(String) - Constructor for class com.couchbase.lite.SessionAuthenticator
-
Initializes with the Sync Gateway session ID and uses the default cookie name.
- SessionAuthenticator(String, String) - Constructor for class com.couchbase.lite.SessionAuthenticator
-
Initializes with the session ID and the cookie name.
- setAcceptOnlySelfSignedServerCertificate(boolean) - Method in class com.couchbase.lite.ReplicatorConfiguration
-
ENTERPRISE EDITION API
- setAcceptParentDomainCookies(boolean) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
The option to remove a restriction that does not allow a replicator to accept cookies from a remote host unless the cookie domain exactly matches the the domain of the sender.
- setArray(int, Array) - Method in class com.couchbase.lite.MutableArray
-
Sets a Array object at the given index.
- setArray(String, Array) - Method in class com.couchbase.lite.MutableDictionary
-
Set an Array object for the given key.
- setArray(String, Array) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setArray(String, Array) - Method in class com.couchbase.lite.MutableDocument
-
Set an Array value for the given key
- setArray(String, Array) - Method in class com.couchbase.lite.Parameters
-
Set the Array value to the query parameter referenced by the given name.
- setAuthenticator(Authenticator) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Sets the authenticator to authenticate with a remote target server.
- setAuthenticator(ListenerAuthenticator) - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Set the authenticator.
- setAutoPurgeEnabled(boolean) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Enable/disable auto-purge.
- setBlob(int, Blob) - Method in class com.couchbase.lite.MutableArray
-
Sets a Blob object at the given index.
- setBlob(String, Blob) - Method in class com.couchbase.lite.MutableDictionary
-
Set a Blob object for the given key.
- setBlob(String, Blob) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setBlob(String, Blob) - Method in class com.couchbase.lite.MutableDocument
-
Set a Blob value for the given key
- setBlob(String, Blob) - Method in class com.couchbase.lite.Parameters
-
Set the Blob value to the query parameter referenced by the given name.
- setBoolean(int, boolean) - Method in class com.couchbase.lite.MutableArray
-
Sets a boolean value at the given index.
- setBoolean(String, boolean) - Method in class com.couchbase.lite.MutableDictionary
-
Set a boolean value for the given key.
- setBoolean(String, boolean) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setBoolean(String, boolean) - Method in class com.couchbase.lite.MutableDocument
-
Set a boolean value for the given key
- setBoolean(String, boolean) - Method in class com.couchbase.lite.Parameters
-
Set a boolean value to the query parameter referenced by the given name.
- setC4DatabaseLocked(C4Database) - Method in class com.couchbase.lite.BaseDatabase
- setChannels(List<String>) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.setChannels
- setChannels(List<String>) - Method in class com.couchbase.lite.CollectionConfiguration
-
Sets a collection of Sync Gateway channel names from which to pull Documents.
- setConfig(LogFileConfiguration) - Method in class com.couchbase.lite.FileLogger
-
Sets the configuration for use by the file logger.
- setConflictResolver(ConflictResolver) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.setConflictResolver
- setConflictResolver(ConflictResolver) - Method in class com.couchbase.lite.CollectionConfiguration
-
Sets the conflict resolver.
- setContent(Dictionary) - Method in class com.couchbase.lite.Document
- setContinuous(boolean) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Sets whether the replicator stays active indefinitely to replicate changed documents.
- setCustom(Logger) - Method in class com.couchbase.lite.Log
-
Sets an application specific logging method
- setData(List<Object>) - Method in class com.couchbase.lite.MutableArray
-
Populate an array with content from a Map.
- setData(Map<String, Object>) - Method in class com.couchbase.lite.MutableDictionary
-
Populate a dictionary with content from a Map.
- setData(Map<String, Object>) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setData(Map<String, Object>) - Method in class com.couchbase.lite.MutableDocument
-
Populate a document with content from a Map.
- setDate(int, Date) - Method in class com.couchbase.lite.MutableArray
-
Sets a Date object at the given index.
- setDate(String, Date) - Method in class com.couchbase.lite.MutableDictionary
-
Set a Date object for the given key.
- setDate(String, Date) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setDate(String, Date) - Method in class com.couchbase.lite.MutableDocument
-
Set a Date value for the given key
- setDate(String, Date) - Method in class com.couchbase.lite.Parameters
-
Set a date value to the query parameter referenced by the given name.
- setDictionary(int, Dictionary) - Method in class com.couchbase.lite.MutableArray
-
Sets a Dictionary object at the given index.
- setDictionary(String, Dictionary) - Method in class com.couchbase.lite.MutableDictionary
-
Set a Dictionary object for the given key.
- setDictionary(String, Dictionary) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setDictionary(String, Dictionary) - Method in class com.couchbase.lite.MutableDocument
-
Set a Dictionary value for the given key
- setDictionary(String, Dictionary) - Method in class com.couchbase.lite.Parameters
-
Set the Dictionary value to the query parameter referenced by the given name.
- setDirectory(String) - Method in class com.couchbase.lite.DatabaseConfiguration
-
Set the canonical path of the directory in which to store the database.
- setDisableTls(boolean) - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Set the configured security protocol.
- setDocumentExpiration(String, Date) - Method in class com.couchbase.lite.Database
-
Deprecated.Use getDefaultCollection().setDocumentExpiration
- setDocumentExpiration(String, Date) - Method in class com.couchbase.lite.Collection
-
Set an expiration date to the document of the given id.
- setDocumentIDs(List<String>) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.setDocumentIDs
- setDocumentIDs(List<String>) - Method in class com.couchbase.lite.CollectionConfiguration
-
Sets a collection of document IDs to filter by: if given, only documents with these IDs will be pushed and/or pulled.
- setDomains(LogDomain...) - Method in class com.couchbase.lite.ConsoleLogger
-
Sets the domains that will be considered for writing to the console log.
- setDomains(EnumSet<LogDomain>) - Method in class com.couchbase.lite.ConsoleLogger
-
Sets the domains that will be considered for writing to the console log.
- setDouble(int, double) - Method in class com.couchbase.lite.MutableArray
-
Sets a double value at the given index.
- setDouble(String, double) - Method in class com.couchbase.lite.MutableDictionary
-
Set a double value for the given key.
- setDouble(String, double) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setDouble(String, double) - Method in class com.couchbase.lite.MutableDocument
-
Set a double value for the given key
- setDouble(String, double) - Method in class com.couchbase.lite.Parameters
-
Set a double value to the query parameter referenced by the given name.
- setEnableDeltaSync(boolean) - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Set delta sync enabled.
- setEncryptionKey(EncryptionKey) - Method in class com.couchbase.lite.DatabaseConfiguration
-
ENTERPRISE EDITION API
- setError(CouchbaseLiteException) - Method in class com.couchbase.lite.ReplicatedDocument
-
Set the current document replication error.
- setExpression(Expression) - Method in class com.couchbase.lite.SelectResult
- setFloat(int, float) - Method in class com.couchbase.lite.MutableArray
-
Sets a float value at the given index.
- setFloat(String, float) - Method in class com.couchbase.lite.MutableDictionary
-
Set a float value for the given key.
- setFloat(String, float) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setFloat(String, float) - Method in class com.couchbase.lite.MutableDocument
-
Set a float value for the given key
- setFloat(String, float) - Method in class com.couchbase.lite.Parameters
-
Set a float value to the query parameter referenced by the given name.
- setFullSync(boolean) - Method in class com.couchbase.lite.DatabaseConfiguration
-
As Couchbase Lite normally configures its databases, there is a very small (though non-zero) chance that a power failure at just the wrong time could cause the most recently committed transaction's changes to be lost.
- setHeaders(Map<String, String>) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Sets the extra HTTP headers to send in all requests to the remote target.
- setHeartbeat(int) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Set the heartbeat interval, in seconds.
- setIgnoreAccents(boolean) - Method in class com.couchbase.lite.Collation
- setIgnoreAccents(boolean) - Method in class com.couchbase.lite.Collation.Unicode
-
Specifies whether the collation ignore the accents or diacritics when comparing the strings or not.
- setIgnoreCase(boolean) - Method in class com.couchbase.lite.Collation.ASCII
-
Specifies whether the collation is case-insensitive or not.
- setIgnoreCase(boolean) - Method in class com.couchbase.lite.Collation
- setIgnoreCase(boolean) - Method in class com.couchbase.lite.Collation.Unicode
-
Specifies whether the collation is case-insensitive or not.
- setInt(int, int) - Method in class com.couchbase.lite.MutableArray
-
Sets an integer value at the given index.
- setInt(String, int) - Method in class com.couchbase.lite.MutableDictionary
-
Set an int value for the given key.
- setInt(String, int) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setInt(String, int) - Method in class com.couchbase.lite.MutableDocument
-
Set a integer value for the given key
- setInt(String, int) - Method in class com.couchbase.lite.Parameters
-
Set an int value to the query parameter referenced by the given name.
- setJSON(String) - Method in class com.couchbase.lite.MutableArray
-
Populate an array with content from a JSON string.
- setJSON(String) - Method in class com.couchbase.lite.MutableDictionary
-
Populate a dictionary with content from a JSON string.
- setJSON(String) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setJSON(String) - Method in class com.couchbase.lite.MutableDocument
-
Populate a document with content from a JSON string.
- setLanguage(String) - Method in class com.couchbase.lite.FullTextIndex
-
The language code which is an ISO-639 language such as "en", "fr", etc.
- setLanguage(String) - Method in class com.couchbase.lite.FullTextIndexConfiguration
-
The language code which is an ISO-639 language such as "en", "fr", etc.
- setLevel(LogLevel) - Method in class com.couchbase.lite.ConsoleLogger
-
Sets the lowest level that will be logged to the console.
- setLevel(LogLevel) - Method in class com.couchbase.lite.FileLogger
-
Sets the overall logging level that will be written to the logging files.
- setLocale(String) - Method in class com.couchbase.lite.Collation
- setLocale(String) - Method in class com.couchbase.lite.Collation.Unicode
-
Specifies the locale to allow the collation to compare strings appropriately based on the locale.
- setLong(int, long) - Method in class com.couchbase.lite.MutableArray
-
Sets an integer value at the given index.
- setLong(String, long) - Method in class com.couchbase.lite.MutableDictionary
-
Set a long value for the given key.
- setLong(String, long) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setLong(String, long) - Method in class com.couchbase.lite.MutableDocument
-
Set a long value for the given key
- setLong(String, long) - Method in class com.couchbase.lite.Parameters
-
Set an long value to the query parameter referenced by the given name.
- setMaxAttempts(int) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Set the max number of retry attempts made after a connection failure.
- setMaxAttemptWaitTime(int) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Set the max time between retry attempts, in seconds.
- setMaxRotateCount(int) - Method in class com.couchbase.lite.LogFileConfiguration
-
Sets the number of rotated logs that are saved.
- setMaxSize(long) - Method in class com.couchbase.lite.LogFileConfiguration
-
Sets the max size of the log file in bytes.
- setNetworkInterface(String) - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Set the configured network interface.
- setNumber(int, Number) - Method in class com.couchbase.lite.MutableArray
-
Sets an NSNumber object at the given index.
- setNumber(String, Number) - Method in class com.couchbase.lite.MutableDictionary
-
Set a Number value for the given key.
- setNumber(String, Number) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setNumber(String, Number) - Method in class com.couchbase.lite.MutableDocument
-
Set a Number value for the given key
- setNumber(String, Number) - Method in class com.couchbase.lite.Parameters
-
Set an Number value to the query parameter referenced by the given name.
- setParameters(Parameters) - Method in class com.couchbase.lite.GroupBy
-
Set query parameters.
- setParameters(Parameters) - Method in interface com.couchbase.lite.Query
-
Set parameters should copy the given parameters.
- setPinnedServerCertificate(byte[]) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Please use setPinnedServerX509Certificate(Certificate)
- setPinnedServerX509Certificate(X509Certificate) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Sets the certificate used to authenticate the target server.
- setPort(int) - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Set the configured port.
- setPullFilter(ReplicationFilter) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.setPullFilter
- setPullFilter(ReplicationFilter) - Method in class com.couchbase.lite.CollectionConfiguration
-
Sets a filter object for validating whether the documents can be pulled from the remote endpoint.
- setPushFilter(ReplicationFilter) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use CollectionConfiguration.setPushFilter
- setPushFilter(ReplicationFilter) - Method in class com.couchbase.lite.CollectionConfiguration
-
Sets a filter object for validating whether the documents can be pushed to the remote endpoint.
- setReadOnly(boolean) - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Set the connection read-only.
- setReplicatorType(AbstractReplicatorConfiguration.ReplicatorType) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Deprecated.Use setType(AbstractReplicator.ReplicatorType)
- setString(int, String) - Method in class com.couchbase.lite.MutableArray
-
Sets an String object at the given index.
- setString(String, String) - Method in class com.couchbase.lite.MutableDictionary
-
Set a String value for the given key.
- setString(String, String) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setString(String, String) - Method in class com.couchbase.lite.MutableDocument
-
Set a String value for the given key
- setString(String, String) - Method in class com.couchbase.lite.Parameters
-
Set an String value to the query parameter referenced by the given name.
- setTlsIdentity(TLSIdentity) - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
-
Set the certificates and keys for the associated listener.
- setType(ReplicatorType) - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
-
Sets the replicator type indicating the direction of the replicator.
- setUsePlaintext(boolean) - Method in class com.couchbase.lite.LogFileConfiguration
-
Sets whether or not CBL logs in plaintext.
- setValue(int, Object) - Method in class com.couchbase.lite.MutableArray
-
Set an object at the given index.
- setValue(String, Object) - Method in class com.couchbase.lite.MutableDictionary
-
Set an object value by key.
- setValue(String, Object) - Method in interface com.couchbase.lite.MutableDictionaryInterface
- setValue(String, Object) - Method in class com.couchbase.lite.MutableDocument
-
Set an object value by key.
- setValue(String, Object) - Method in class com.couchbase.lite.Parameters
-
Set a value to the query parameter referenced by the given name.
- sign(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a SIGN(expr) function that returns the sign (1: positive, -1: negative, 0: zero) of the given numeric expression.
- sin(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a SIN(expr) function that returns the sin of the given numeric expression.
- SQLITE - Static variable in class com.couchbase.lite.CBLError.Domain
- sqrt(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a SQRT(expr) function that returns the square root of the given numeric expression.
- squaredEuclideanDistance(Expression, Expression) - Static method in class com.couchbase.lite.Function
-
ENTERPRISE EDITION API
- start() - Method in class com.couchbase.lite.AbstractReplicator
-
Start the replicator.
- start() - Method in class com.couchbase.lite.URLEndpointListener
-
Start the listener.
- start(boolean) - Method in class com.couchbase.lite.AbstractReplicator
-
Start the replicator.
- stop() - Method in class com.couchbase.lite.AbstractReplicator
-
Stop a running replicator.
- stop() - Method in class com.couchbase.lite.URLEndpointListener
-
Stop the listener.
- STOPPED - Enum constant in enum class com.couchbase.lite.ReplicatorActivityLevel
-
The replication is finished or hit a fatal error.
- string(String) - Static method in class com.couchbase.lite.Expression
-
Create value expression with given String value
- stringToMillis(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a STR_TO_MILLIS(expr) that will convert an ISO8601 datetime string into the number of milliseconds since the unix epoch.
- stringToUTC(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a STR_TO_UTC(expr) that will convert an ISO8601 datetime string into a full ISO8601 UTC datetime string.
- subtract(Expression) - Method in class com.couchbase.lite.Expression
-
Create a subtract expression to subtract the given expression from the current expression.
- sum(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a SUM(expr) function expression that return the sum of all number values in the group of the values expressed by the given expression.
T
- tan(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a TAN(expr) function that returns the tangent of the given numeric expression.
- throwException(int, int, String) - Static method in exception com.couchbase.lite.LiteCoreException
- TIMEOUT - Static variable in class com.couchbase.lite.CBLError.Code
-
Socket timeout during an operation
- TLS_CERT_EXPIRED - Static variable in class com.couchbase.lite.CBLError.Code
-
The provided TLS certificate has expired
- TLS_CERT_UNKNOWN_ROOT - Static variable in class com.couchbase.lite.CBLError.Code
-
Self-signed cert, or unknown anchor cert
- TLS_CERT_UNTRUSTED - Static variable in class com.couchbase.lite.CBLError.Code
-
Cert isn't trusted for other reason
- TLS_CLIENT_CERT_REJECTED - Static variable in class com.couchbase.lite.CBLError.Code
-
Client certificate was rejected by the server
- TLS_CLIENT_CERT_REQUIRED - Static variable in class com.couchbase.lite.CBLError.Code
-
A required client certificate was not provided
- TLS_HANDSHAKE_FAILED - Static variable in class com.couchbase.lite.CBLError.Code
-
Failure during TLS handshake process
- TLSIdentity - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- toCouchbaseLiteException(int, int, int) - Static method in exception com.couchbase.lite.CouchbaseLiteException
- toCouchbaseLiteException(int, int, String, Exception) - Static method in exception com.couchbase.lite.CouchbaseLiteException
- toData() - Method in class com.couchbase.lite.Message
-
Gets the message as data.
- toJSON() - Method in class com.couchbase.lite.Array
- toJSON() - Method in interface com.couchbase.lite.ArrayInterface
- toJSON() - Method in class com.couchbase.lite.Blob
- toJSON() - Method in class com.couchbase.lite.Dictionary
- toJSON() - Method in interface com.couchbase.lite.DictionaryInterface
- toJSON() - Method in class com.couchbase.lite.Document
- toJSON() - Method in class com.couchbase.lite.MutableArray
- toJSON() - Method in class com.couchbase.lite.MutableDictionary
- toJSON() - Method in class com.couchbase.lite.MutableDocument
-
Unimplemented: Mutable objects may not be encoded as JSON
- toJSON() - Method in class com.couchbase.lite.Result
- toList() - Method in class com.couchbase.lite.Array
-
Gets content of the current object as an List.
- toList() - Method in interface com.couchbase.lite.ArrayInterface
- toList() - Method in class com.couchbase.lite.Result
-
Gets all the values as a List.
- toMap() - Method in class com.couchbase.lite.Dictionary
-
Gets content of the current object as an Map.
- toMap() - Method in interface com.couchbase.lite.DictionaryInterface
- toMap() - Method in class com.couchbase.lite.Document
-
Gets content of the current object as an Map.
- toMap() - Method in class com.couchbase.lite.Result
-
Gets all values as a Map.
- toMutable() - Method in class com.couchbase.lite.Array
-
Return a mutable copy of the array
- toMutable() - Method in class com.couchbase.lite.Dictionary
-
Return a mutable copy of the dictionary
- toMutable() - Method in class com.couchbase.lite.Document
-
Return a mutable copy of the document
- toMutable() - Method in class com.couchbase.lite.MutableDocument
-
Returns the copy of this MutableDocument object.
- toNative(MValue, MCollection, AtomicBoolean) - Method in class com.couchbase.lite.MValueConverter
- TOO_MANY_REDIRECTS - Static variable in class com.couchbase.lite.CBLError.Code
-
Too many HTTP redirects for the HTTP client to handle
- toString() - Method in class com.couchbase.lite.Database
- toString() - Method in class com.couchbase.lite.AbstractIndex
- toString() - Method in class com.couchbase.lite.AbstractReplicator
- toString() - Method in class com.couchbase.lite.AbstractReplicatorConfiguration
- toString() - Method in class com.couchbase.lite.Array
- toString() - Method in class com.couchbase.lite.Blob
-
Returns a string representation of the object.
- toString() - Method in class com.couchbase.lite.GroupBy
- toString() - Method in class com.couchbase.lite.Collation
- toString() - Method in class com.couchbase.lite.Collection
- toString() - Method in class com.couchbase.lite.CollectionChange
- toString() - Method in class com.couchbase.lite.CollectionConfiguration
- toString() - Method in class com.couchbase.lite.ConnectionStatus
- toString() - Method in exception com.couchbase.lite.CouchbaseLiteException
- toString() - Method in class com.couchbase.lite.DatabaseChange
-
Deprecated.
- toString() - Method in class com.couchbase.lite.DatabaseEndpoint
- toString() - Method in class com.couchbase.lite.Dictionary
- toString() - Method in class com.couchbase.lite.Document
- toString() - Method in class com.couchbase.lite.DocumentChange
- toString() - Method in class com.couchbase.lite.DocumentReplication
- toString() - Method in class com.couchbase.lite.Expression
- toString() - Method in class com.couchbase.lite.ListenerToken
- toString() - Method in exception com.couchbase.lite.LiteCoreException
- toString() - Method in enum class com.couchbase.lite.LogLevel
- toString() - Method in class com.couchbase.lite.MessageEndpoint
- toString() - Method in class com.couchbase.lite.MessageEndpointListenerChange
- toString() - Method in class com.couchbase.lite.MessagingError
- toString() - Method in class com.couchbase.lite.QueryChange
- toString() - Method in class com.couchbase.lite.ReplicatedDocument
- toString() - Method in class com.couchbase.lite.ReplicatorChange
- toString() - Method in class com.couchbase.lite.ReplicatorProgress
- toString() - Method in class com.couchbase.lite.ReplicatorStatus
- toString() - Method in class com.couchbase.lite.Scope
- toString() - Method in class com.couchbase.lite.URLEndpoint
- toString() - Method in class com.couchbase.lite.URLEndpointListener
- toString() - Method in class com.couchbase.lite.URLEndpointListenerConfiguration
- TRANSACTION_NOT_CLOSED - Static variable in class com.couchbase.lite.CBLError.Code
-
Database can't be closed while a transaction is open
- trim(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a TRIM(expr) function that removes the whitespace from the beginning and the end of the given string expression.
- trunc(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a TRUNC(expr) function that truncates all of the digits after the decimal place of the given numeric expression.
- trunc(Expression, Expression) - Static method in class com.couchbase.lite.Function
-
Creates a TRUNC(expr, digits) function that truncates the number of the digits after the decimal place of the given numeric expression.
- TYPE - Static variable in class com.couchbase.lite.Defaults.Replicator
-
Perform bidirectional replication
U
- UNEXPECTED_ERROR - Static variable in class com.couchbase.lite.CBLError.Code
-
Internal unexpected C++ exception
- unicode() - Static method in class com.couchbase.lite.Collation
-
Creates a Unicode collation that will compare two strings by using Unicode Collation Algorithm.
- UNIMPLEMENTED - Static variable in class com.couchbase.lite.CBLError.Code
-
An unimplemented API call
- UnitOfWork<E extends Exception> - Interface in com.couchbase.lite
-
A task to be performed within a single database transaction.
- UNKNOWN_HOST - Static variable in class com.couchbase.lite.CBLError.Code
-
DNS server doesn't know the hostname
- unregisterModel(String) - Method in class com.couchbase.lite.Prediction
-
Unregister the predictive model of the given name.
- UNSUPPORTED - Static variable in class com.couchbase.lite.CBLError.Code
-
Operation not supported on this database
- UNSUPPORTED_ENCRYPTION - Static variable in class com.couchbase.lite.CBLError.Code
-
Unsupported encryption algorithm
- upper(Expression) - Static method in class com.couchbase.lite.Function
-
Creates a UPPER(expr) function that returns the uppercase string of the given string expression.
- URLEndpoint - Class in com.couchbase.lite
-
URL based replication target endpoint
- URLEndpoint(URI) - Constructor for class com.couchbase.lite.URLEndpoint
-
Constructor with the url.
- URLEndpointListener - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- URLEndpointListener(URLEndpointListenerConfiguration) - Constructor for class com.couchbase.lite.URLEndpointListener
-
Create a URLEndpointListener with the passed configuration.
- URLEndpointListenerConfiguration - Class in com.couchbase.lite
-
ENTERPRISE EDITION API
- URLEndpointListenerConfiguration(Database) - Constructor for class com.couchbase.lite.URLEndpointListenerConfiguration
-
Deprecated.Use URLEndpointListenerConfiguration(Collections)
- URLEndpointListenerConfiguration(URLEndpointListenerConfiguration) - Constructor for class com.couchbase.lite.URLEndpointListenerConfiguration
-
Clone the passed listener configuration.
- URLEndpointListenerConfiguration(Set<Collection>) - Constructor for class com.couchbase.lite.URLEndpointListenerConfiguration
-
Init with the collections that will be available for replication.
- URLEndpointListenerConfiguration(Set<Collection>, String, int, boolean, TLSIdentity, ListenerAuthenticator, boolean, boolean) - Constructor for class com.couchbase.lite.URLEndpointListenerConfiguration
-
Create a URLEndpointListenerConfiguration with the passed properties.
- USE_PLAIN_TEXT - Static variable in class com.couchbase.lite.Defaults.LogFile
-
Plaintext is not used, and instead binary encoding is used in log files
- usesPlaintext() - Method in class com.couchbase.lite.LogFileConfiguration
-
Gets whether or not CBL is logging in plaintext.
V
- value(Object) - Static method in class com.couchbase.lite.Expression
-
Create value expression with given value
- VALUE - Enum constant in enum class com.couchbase.lite.AbstractIndex.IndexType
- valueIndex(ValueIndexItem...) - Static method in class com.couchbase.lite.IndexBuilder
-
Create a value index with the given index items.
- ValueIndex - Class in com.couchbase.lite
-
A Standard query index.
- ValueIndexConfiguration - Class in com.couchbase.lite
-
Configuration for a standard database index.
- ValueIndexConfiguration(String...) - Constructor for class com.couchbase.lite.ValueIndexConfiguration
- ValueIndexItem - Class in com.couchbase.lite
-
Value Index Item
- valueOf(String) - Static method in enum class com.couchbase.lite.AbstractIndex.IndexType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.AbstractIndex.QueryLanguage
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.AbstractReplicatorConfiguration.ReplicatorType
-
Deprecated.Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.ConcurrencyControl
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.DocumentFlag
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.LogDomain
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.LogLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.MaintenanceType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.ProtocolType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.ReplicatorActivityLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.couchbase.lite.ReplicatorType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.couchbase.lite.AbstractIndex.IndexType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.AbstractIndex.QueryLanguage
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.AbstractReplicatorConfiguration.ReplicatorType
-
Deprecated.Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.ConcurrencyControl
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.DocumentFlag
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.LogDomain
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.LogLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.MaintenanceType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.ProtocolType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.ReplicatorActivityLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.couchbase.lite.ReplicatorType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- variable(String) - Static method in class com.couchbase.lite.ArrayExpression
-
Creates a variable expression.
- VariableExpression - Class in com.couchbase.lite
-
Variable expression
- VERBOSE - Enum constant in enum class com.couchbase.lite.LogLevel
-
Low level logging.
- verifyHeartbeat(int) - Static method in class com.couchbase.lite.AbstractReplicatorConfiguration
W
- WARNING - Enum constant in enum class com.couchbase.lite.LogLevel
-
Internal errors that are recoverable; client errors that may not be recoverable
- WEB_SOCKET_ABNORMAL_CLOSE - Static variable in class com.couchbase.lite.CBLError.Code
-
TCP socket closed unexpectedly
- WEB_SOCKET_BAD_MESSAGE_FORMAT - Static variable in class com.couchbase.lite.CBLError.Code
-
Unparseable WebSocket message
- WEB_SOCKET_CANT_FULFILL - Static variable in class com.couchbase.lite.CBLError.Code
-
Can't fulfill request due to "unexpected condition"
- WEB_SOCKET_CLOSE_USER_PERMANENT - Static variable in class com.couchbase.lite.CBLError.Code
-
Exceptions during P2P replication that are permanent will be assigned this error code
- WEB_SOCKET_CLOSE_USER_TRANSIENT - Static variable in class com.couchbase.lite.CBLError.Code
-
Exceptions during P2P replication that are transient will be assigned this error code
- WEB_SOCKET_DATA_ERROR - Static variable in class com.couchbase.lite.CBLError.Code
-
Message payload cannot be handled
- WEB_SOCKET_GOING_AWAY - Static variable in class com.couchbase.lite.CBLError.Code
-
Peer has to close, e.g.
- WEB_SOCKET_MESSAGE_TOO_BIG - Static variable in class com.couchbase.lite.CBLError.Code
-
Message is too large for peer to handle
- WEB_SOCKET_MISSING_EXTENSION - Static variable in class com.couchbase.lite.CBLError.Code
-
Peer doesn't provide a necessary extension
- WEB_SOCKET_NORMAL_CLOSE - Static variable in class com.couchbase.lite.CBLError.Code
-
Not an error: This is the lower bound for WebSocket related errors
- WEB_SOCKET_POLICY_ERROR - Static variable in class com.couchbase.lite.CBLError.Code
-
Message violated unspecified policy
- WEB_SOCKET_PROTOCOL_ERROR - Static variable in class com.couchbase.lite.CBLError.Code
-
Protocol violation: invalid framing data
- WEB_SOCKET_TLS_FAILURE - Static variable in class com.couchbase.lite.CBLError.Code
- WEB_SOCKET_USER - Static variable in class com.couchbase.lite.CBLError.Code
- where(Expression) - Method in class com.couchbase.lite.From
-
Create and chain a WHERE component for specifying the WHERE clause of the query.
- where(Expression) - Method in class com.couchbase.lite.Joins
-
Creates and chains a Where object for specifying the WHERE clause of the query.
- Where - Class in com.couchbase.lite
-
A Where represents the WHERE clause of the query for filtering the query result.
- WRONG_FORMAT - Static variable in class com.couchbase.lite.CBLError.Code
-
Database exists but not in the format/storage requested
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form