Package com.couchbase.lite

Class MultipeerCollectionConfiguration

java.lang.Object

com.couchbase.lite.MultipeerCollectionConfiguration

public final class MultipeerCollectionConfiguration
extends Object

A configuration for a collection in a multipeer environment.

This class allows you to configure document IDs to filter, push and pull filters, and a custom conflict resolver for an associated collection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MultipeerCollectionConfiguration.Builder	The builder for MultipeerCollectionConfigurations.
static interface	MultipeerCollectionConfiguration.ConflictResolver	The conflict resolver interface.
static interface	MultipeerCollectionConfiguration.ReplicationFilter	The replication filter interface.

Method Summary

Modifier and Type	Method	Description
static Set<MultipeerCollectionConfiguration>	fromCollections(Collection<Collection> collections)	Creates a set of MultipeerCollectionConfiguration instances from the given collections.
Collection	getCollection()	The collection.
MultipeerCollectionConfiguration.ConflictResolver	getConflictResolver()	Custom conflict resolver (possibly null).
Set<String>	getDocumentIDs()	Document IDs filter (possibly null).
MultipeerCollectionConfiguration.ReplicationFilter	getPullFilter()	Pull filter (possibly null).
MultipeerCollectionConfiguration.ReplicationFilter	getPushFilter()	Push filter (possibly null).

Methods inherited from class java.lang.Object

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

Method Details

fromCollections

@NonNull
public static Set<MultipeerCollectionConfiguration> fromCollections(@NonNull
 Collection<Collection> collections)

Creates a set of MultipeerCollectionConfiguration instances from the given collections.

Each specified collection will be wrapped in a MultipeerCollectionConfiguration using default settings (no filters and no custom conflict resolvers).

This is a convenience method for configuring multiple collections with default replication settings. If custom configurations are needed, construct MultipeerCollectionConfiguration instances directly instead.

Parameters:

collections - A collection of Collection instances to replicate.

Returns:

A set of MultipeerCollectionConfiguration instances for the provided collections.

getCollection

@NonNull
public Collection getCollection()

The collection.

getDocumentIDs

@Nullable
public Set<String> getDocumentIDs()

Document IDs filter (possibly null).

getPushFilter

@Nullable
public MultipeerCollectionConfiguration.ReplicationFilter getPushFilter()

Push filter (possibly null).

getPullFilter

@Nullable
public MultipeerCollectionConfiguration.ReplicationFilter getPullFilter()

Pull filter (possibly null).

getConflictResolver

@Nullable
public MultipeerCollectionConfiguration.ConflictResolver getConflictResolver()

Custom conflict resolver (possibly null).