Scope (Couchbase, Inc. Enterprise Edition License Agreement 3.1.0-413)

java.lang.Object
- com.couchbase.lite.Scope

public class Scope
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String DEFAULT_NAME

Method Summary

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_NAME
```
public static final java.lang.String DEFAULT_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
@NonNull
public java.lang.String getName()
```
    Get the scope name.
    
    Returns:
    
    Scope name
  - getCollections
```
@NonNull
public java.util.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
                                java.lang.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 java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object