com.couchbase.client.java.view

Class DesignDocument

java.lang.Object

com.couchbase.client.java.view.DesignDocument

public class DesignDocument
extends Object

Represents a design document to store and load.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DesignDocument.Option Optional design document options.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DesignDocument(String name, List<View> views, Map<DesignDocument.Option,Long> options)

Method Summary

Modifier and Type	Method and Description
static DesignDocument	create(String name, List<View> views) Creates a new DesignDocument.
static DesignDocument	create(String name, List<View> views, Map<DesignDocument.Option,Long> options) Creates a new DesignDocument.
boolean	equals(Object o)
static DesignDocument	from(String name, JsonObject raw)
int	hashCode()
String	name()
Map<DesignDocument.Option,Long>	options()
JsonObject	toJsonObject()
String	toString()
List<View>	views()

Methods inherited from class java.lang.Object

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

Constructor Detail

DesignDocument

protected DesignDocument(String name,
                         List<View> views,
                         Map<DesignDocument.Option,Long> options)

Method Detail

create

public static DesignDocument create(String name,
                                    List<View> views)

Creates a new DesignDocument.

Parameters:

name - the name of the design document.

views - all views it contains.

Returns:

a new DesignDocument.

create

public static DesignDocument create(String name,
                                    List<View> views,
                                    Map<DesignDocument.Option,Long> options)

Creates a new DesignDocument.

Parameters:

name - the name of the design document.

views - all views it contains.

options - optional options of the design document.

Returns:

a new DesignDocument.

from

public static DesignDocument from(String name,
                                  JsonObject raw)

name

public String name()

views

public List<View> views()

options

public Map<DesignDocument.Option,Long> options()

toString

public String toString()

Overrides:

toString in class Object

toJsonObject

public JsonObject toJsonObject()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object