Package io.nitric.api.document

Class AbstractCollection

java.lang.Object

io.nitric.api.document.AbstractCollection

Direct Known Subclasses:

Collection, CollectionGroup

public class AbstractCollection
extends Object

Provides an abstract Collection class.

Method Summary

Modifier and Type	Method	Description
String	getName()	Return the collection name.
Key	getParent()	Return the collection parent key.
Query<Map>	query()	Create a new query object with the Map value type.
<T> Query<T>	query(Class<T> type)	Create a new query object with the given value type.
String	toString()	Return this string representation of this object.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Return the collection name.

Returns:

the collection name

getParent

public Key getParent()

Return the collection parent key.

Returns:

the collection parent key

query

public Query<Map> query()

Create a new query object with the Map value type.

Returns:

a new query object

query

public <T> Query<T> query(Class<T> type)

Create a new query object with the given value type.

Parameters:

type - the query value type (required)

Returns:

a new query object

toString

public String toString()

Return this string representation of this object.

Overrides:

toString in class Object

Returns:

the string representation of this object