Package com.couchbase.lite

Class Scope

java.lang.Object

com.couchbase.lite.Scope

public class Scope
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Collection	getCollection(String collectionName)	Get the named collection for the scope.
Set<Collection>	getCollections()	Get all collections in the scope.
String	getName()	Get the scope name.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

• Constant Field Values

Method Details

getName

@NonNull
public String getName()

Get the scope name.

Returns:

Scope name

getCollections

@NonNull
public Set<Collection> getCollections()
                               throws CouchbaseLiteException

Get all collections in the scope.

Returns:

a set of all collections in the scope

Throws:

CouchbaseLiteException

getCollection

@Nullable
public Collection getCollection(@NonNull
 String collectionName)
                         throws CouchbaseLiteException

Get the named collection for the scope.

Parameters:

collectionName - the name of the sought collection

Returns:

the named collection or null

Throws:

CouchbaseLiteException

toString

@NonNull
public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object