com.baasbox.android

Class BaasDocument

java.lang.Object

com.baasbox.android.BaasObject

com.baasbox.android.BaasDocument

All Implemented Interfaces:

android.os.Parcelable, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>

public final class BaasDocument
extends BaasObject
implements java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>, android.os.Parcelable

Represents a BaasBox document.

A document is a schema less JSON like entity that belongs to a given collection on the server.

Documents can be created, stored and retrieved from the server, either synchronously or asynchronously, through the provided methods.

Unlike a raw JSON document, some key names at the top level are reserved: you cannot assign or create properties whose names begin with an underscore or an at sign, the id field is also reserved.

When a document is bound to an entity on the server it's 'id' can be retrieved through BaasDocument.getId(). Documents are versioned by BaasBox and updates with incompatible versions will fail, uless you ignore the versioning explicitly through SaveMode.IGNORE_VERSION.

Since:

0.7.3

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<BaasDocument>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
BaasDocument(java.lang.String collection) Creates a new unbound empty document belonging to the given collection
BaasDocument(java.lang.String collection, android.content.ContentValues values) Creates a new unbound document that belongs to the given collection and with fields initialized from the values ContentValues values are converted to a JsonObject using JsonObject.from(android.content.ContentValues)
BaasDocument(java.lang.String collection, JsonObject data) Creates a new unbound document that belongs to the given collection and with fields initialized from the data JsonObject.

Method Summary

Modifier and Type	Method and Description
BaasDocument	clear() Removes all the mappings from this document
boolean	contains(java.lang.String name) Checks if this document contains a mapping with name key
static RequestToken	count(java.lang.String collection, BaasHandler<java.lang.Long> handler) Asynchronously retrieves the number of documents readable to the user in collection.
static RequestToken	count(java.lang.String collection, BaasQuery.Criteria filter, BaasHandler<java.lang.Long> handler) Asynchronously retrieves the number of documents readable to the user that match the filter in collection.
static RequestToken	count(java.lang.String collection, int flags, BaasHandler<java.lang.Long> handler) Asynchronously retrieves the number of documents readable to the user in collection
static BaasResult<java.lang.Long>	countSync(java.lang.String collection) Synchronously retrieves the number of document readable to the user in collection
static BaasResult<java.lang.Long>	countSync(java.lang.String collection, BaasQuery.Criteria filter) Synchronously retrieves the number of document readable to the user that match filter in collection
RequestToken	delete(BaasHandler<java.lang.Void> handler)
RequestToken	delete(int flags, BaasHandler<java.lang.Void> handler)
static RequestToken	delete(java.lang.String collection, java.lang.String id, BaasHandler<java.lang.Void> handler)
static RequestToken	delete(java.lang.String collection, java.lang.String id, int flags, BaasHandler<java.lang.Void> handler)
BaasResult<java.lang.Void>	deleteSync()
static BaasResult<java.lang.Void>	deleteSync(java.lang.String collection, java.lang.String id)
int	describeContents()
static RequestToken	fetch(java.lang.String collection, java.lang.String id, BaasHandler<BaasDocument> handler) Asynchronously fetches the document identified by id in collection
static RequestToken	fetchAll(java.lang.String collection, BaasHandler<java.util.List<BaasDocument>> handler) Asynchronously retrieves the list of documents readable to the user in collection.
static RequestToken	fetchAll(java.lang.String collection, BaasQuery.Criteria filter, BaasHandler<java.util.List<BaasDocument>> handler) Asynchronously retrieves the list of documents readable to the user that match filter in collection
static RequestToken	fetchAll(java.lang.String collection, BaasQuery.Criteria filter, int flags, BaasHandler<java.util.List<BaasDocument>> handler) Asynchronously retrieves the list of documents readable to the user in collection
static BaasResult<java.util.List<BaasDocument>>	fetchAllSync(java.lang.String collection)
static BaasResult<java.util.List<BaasDocument>>	fetchAllSync(java.lang.String collection, BaasQuery.Criteria filter) Synchronously retrieves the list of documents readable to the user in collection
static BaasResult<BaasDocument>	fetchSync(java.lang.String collection, java.lang.String id) Synchronously fetches a document from the server
java.util.Set<java.lang.String>	fields() Returns a java.util.Set of all the keys contained in this document
static BaasDocument	from(JsonObject data) Returns a new BaasDocument from it's raw json representation
JsonArray	getArray(java.lang.String name) Returns the value mapped to name as a JsonArray or null if the mapping is absent.
JsonArray	getArray(java.lang.String name, JsonArray otherwise) Returns the value mapped to name as a JsonArray or otherwise if the mapping is absent.
java.lang.String	getAuthor() The username of the owner of this object, or null if this object is new.
byte[]	getBinary(java.lang.String name) Returns the value mapped to name as a byte[] array or null if the mapping is absent.
byte[]	getBinary(java.lang.String name, byte[] otherwise) Returns the value mapped to name as a byte[] array or otherwise if the mapping is absent.
java.lang.Boolean	getBoolean(java.lang.String name) Returns the value mapped to name as a Boolean or null if the mapping is absent.
boolean	getBoolean(java.lang.String name, boolean otherwise) Returns the value mapped to name as a boolean or otherwise if the mapping is absent.
java.lang.String	getCollection() Returns the collection to which this document belongs.
java.lang.String	getCreationDate() The date this object was created on the server, or null if the object is new.
java.lang.Double	getDouble(java.lang.String name) Returns the value mapped to name as a Double or null if the mapping is absent.
double	getDouble(java.lang.String name, double otherwise) Returns the value mapped to name as a double or otherwise if the mapping is absent.
java.lang.Float	getFloat(java.lang.String name) Returns the value mapped to name as a Float or null if the mapping is absent.
float	getFloat(java.lang.String name, float otherwise) Returns the value mapped to name as a float or otherwise if the mapping is absent.
java.lang.String	getId() The id of this object on the server.
java.lang.Integer	getInt(java.lang.String name) Returns the value mapped to name as a Integer or null if the mapping is absent.
int	getInt(java.lang.String name, int otherwise) Returns the value mapped to name as a int or otherwise if the mapping is absent.
java.lang.Long	getLong(java.lang.String name) Returns the value mapped to name as a Long or null if the mapping is absent.
long	getLong(java.lang.String name, long otherwise) Returns the value mapped to name as a long or otherwise if the mapping is absent.
JsonObject	getObject(java.lang.String name) Returns the value mapped to name as a JsonObject or null if the mapping is absent.
JsonObject	getObject(java.lang.String name, JsonObject otherwise) Returns the value mapped to name as a JsonObject or otherwise if the mapping is absent.
java.lang.String	getString(java.lang.String name) Returns the value mapped to name as a String or null if the mapping is absent.
java.lang.String	getString(java.lang.String name, java.lang.String otherwise) Returns the value mapped to name as a String or otherwise if the mapping is absent.
JsonStructure	getStructure(java.lang.String name) Returns the value mapped to name as a JsonStructure or null if the mapping is absent.
JsonStructure	getStructure(java.lang.String name, JsonStructure otherwise) Returns the value mapped to name as a JsonStructure or otherwise if the mapping is absent.
long	getVersion() The version number of this object.
RequestToken	grant(Grant grant, java.lang.String username, int flags, BaasHandler<java.lang.Void> handler) Asynchronously grants the access grant to this object to username.
RequestToken	grantAll(Grant grant, java.lang.String role, int flags, BaasHandler<java.lang.Void> handler) Asynchronously grants the access grant to this object to users with role.
BaasResult<java.lang.Void>	grantAllSync(Grant grant, java.lang.String role) Synchronously grants the acces grant to this object to all users in role
BaasResult<java.lang.Void>	grantSync(Grant grant, java.lang.String username) Synchronously grants the access grant to this object to username.
boolean	isDirty()
boolean	isDocument()
boolean	isFile()
boolean	isNull(java.lang.String name) Checks if name maps explicitly to null
java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.Object>>	iterator() Returns an Iterator over the mappings of this document
BaasDocument	merge(JsonObject other) Merges the content of other into this document overwriting any mapping for wich other contains a key.
BaasDocument	put(java.lang.String name, boolean value) Associate name key to the boolean value in this document.
BaasDocument	put(java.lang.String name, byte[] value) Associate name key to the byte[] value in this document.
BaasDocument	put(java.lang.String name, double value) Associate name key to the double value in this document.
BaasDocument	put(java.lang.String name, JsonArray value) Associate name key to the JsonArray value in this document.
BaasDocument	put(java.lang.String name, JsonObject value) Associate name key to the JsonObject value in this document.
BaasDocument	put(java.lang.String name, long value) Associate name key to the long value in this document.
BaasDocument	put(java.lang.String name, java.lang.String value) Associate name key to the String value in this document.
BaasDocument	putNull(java.lang.String name) Puts an explicit mapping to from name to null in this document.
RequestToken	refresh(BaasHandler<BaasDocument> handler) Asynchronously refresh the content of this document.
BaasResult<BaasDocument>	refreshSync() Synchronously refresh the content of this document
java.lang.Object	remove(java.lang.String name) Removes the mapping with name key from the document.
RequestToken	revoke(Grant grant, java.lang.String username, int flags, BaasHandler<java.lang.Void> handler) Asynchronously revoke the access grant to this object to username.
RequestToken	revokeAll(Grant grant, java.lang.String role, int flags, BaasHandler<java.lang.Void> handler) Asynchronously revokes the access grant to this object from users with role.
BaasResult<java.lang.Void>	revokeAllSync(Grant grant, java.lang.String role) Synchronously revokes the acces grant to this object from all users in role
BaasResult<java.lang.Void>	revokeSync(Grant grant, java.lang.String username) Synchronously revokes the access grant to this object from username.
RequestToken	save(BaasHandler<BaasDocument> handler)
RequestToken	save(SaveMode mode, BaasHandler<BaasDocument> handler)
RequestToken	save(SaveMode mode, int flags, BaasHandler<BaasDocument> handler)
BaasResult<BaasDocument>	saveSync()
BaasResult<BaasDocument>	saveSync(SaveMode mode)
int	size() Returns the number of mappings contained in this document.
JsonObject	toJson()
JsonArray	values() Returns a JsonArray representation of the values contained in this document.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.baasbox.android.BaasObject

asDocument, asFile, grant, grantAll, isNew, revoke, revokeAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

CREATOR

public static android.os.Parcelable.Creator<BaasDocument> CREATOR

Constructor Detail

BaasDocument

public BaasDocument(java.lang.String collection)

Creates a new unbound empty document belonging to the given collection

Parameters:

collection - a non empty collection name.

Throws:

java.lang.IllegalArgumentException - if collection name is empty

BaasDocument

public BaasDocument(java.lang.String collection,
                    JsonObject data)

Creates a new unbound document that belongs to the given collection and with fields initialized from the data JsonObject.

Data cannot contain reserved property names at the top level. Note that the JSON data is copied in the document, so modifications to the original instance will not be reflected by the document.

Parameters:

collection - a non empty collection name.

data - a possibly null JsonObject

Throws:

java.lang.IllegalArgumentException - if collection name is empty or data contains reserved fields

BaasDocument

public BaasDocument(java.lang.String collection,
                    android.content.ContentValues values)

Creates a new unbound document that belongs to the given collection and with fields initialized from the values ContentValues values are converted to a JsonObject using JsonObject.from(android.content.ContentValues)

Parameters:

collection - a non empty collection name.

values - a possibly null ContentValues

Throws:

java.lang.IllegalArgumentException - if collection name is empty or values contains reserved fields names

Method Detail

from

public static BaasDocument from(JsonObject data)

Returns a new BaasDocument from it's raw json representation

Parameters:

data -

Returns:

a new BaasDocument

isDocument

public final boolean isDocument()

Specified by:

isDocument in class BaasObject

isFile

public final boolean isFile()

Specified by:

isFile in class BaasObject

toJson

public JsonObject toJson()

fetchAll

public static RequestToken fetchAll(java.lang.String collection,
                                    BaasHandler<java.util.List<BaasDocument>> handler)

Asynchronously retrieves the list of documents readable to the user in collection.

Parameters:

collection - the collection to retrieve not null

handler - a callback to be invoked with the result of the request

Returns:

a RequestToken to handle the asynchronous request

fetchAll

public static RequestToken fetchAll(java.lang.String collection,
                                    BaasQuery.Criteria filter,
                                    BaasHandler<java.util.List<BaasDocument>> handler)

Asynchronously retrieves the list of documents readable to the user that match filter in collection

Parameters:

collection - the collection to retrieve not null

filter - a filter to apply to the request

handler - a callback to be invoked with the result of the request

Returns:

a RequestToken to handle the asynchronous request

fetchAll

public static RequestToken fetchAll(java.lang.String collection,
                                    BaasQuery.Criteria filter,
                                    int flags,
                                    BaasHandler<java.util.List<BaasDocument>> handler)

Asynchronously retrieves the list of documents readable to the user in collection

Parameters:

collection - the collection to retrieve not null

flags - RequestOptions

handler - a callback to be invoked with the result of the request

Returns:

a RequestToken to handle the asynchronous request

fetchAllSync

public static BaasResult<java.util.List<BaasDocument>> fetchAllSync(java.lang.String collection)

fetchAllSync

public static BaasResult<java.util.List<BaasDocument>> fetchAllSync(java.lang.String collection,
                                                                    BaasQuery.Criteria filter)

Synchronously retrieves the list of documents readable to the user in collection

Parameters:

collection - the collection to retrieve not null

Returns:

the result of the request

count

public static RequestToken count(java.lang.String collection,
                                 BaasHandler<java.lang.Long> handler)

Asynchronously retrieves the number of documents readable to the user in collection.

Parameters:

collection - the collection to count not null

handler - a callback to be invoked with the result of the request

Returns:

a RequestToken to handle the asynchronous request

count

public static RequestToken count(java.lang.String collection,
                                 BaasQuery.Criteria filter,
                                 BaasHandler<java.lang.Long> handler)

Asynchronously retrieves the number of documents readable to the user that match the filter in collection.

Parameters:

collection - the collection to count not null

filter - a BaasQuery.Criteria to apply to the request. May be null

handler - a callback to be invoked with the result of the request

Returns:

a RequestToken to handle the asynchronous request

count

public static RequestToken count(java.lang.String collection,
                                 int flags,
                                 BaasHandler<java.lang.Long> handler)

Asynchronously retrieves the number of documents readable to the user in collection

Parameters:

collection - the collection to count not null

flags - RequestOptions

handler - a callback to be invoked with the result of the request

Returns:

a RequestToken to handle the asynchronous request

countSync

public static BaasResult<java.lang.Long> countSync(java.lang.String collection)

Synchronously retrieves the number of document readable to the user in collection

Parameters:

collection - the collection to count not null

Returns:

the result of the request

countSync

public static BaasResult<java.lang.Long> countSync(java.lang.String collection,
                                                   BaasQuery.Criteria filter)

Synchronously retrieves the number of document readable to the user that match filter in collection

Parameters:

collection - the collection to count not null

filter - a filter to apply to the request

Returns:

the result of the request

fetch

public static RequestToken fetch(java.lang.String collection,
                                 java.lang.String id,
                                 BaasHandler<BaasDocument> handler)

Asynchronously fetches the document identified by id in collection

Parameters:

collection - the collection to retrieve the document from. Not null

id - the id of the document to retrieve. Not null

handler - a callback to be invoked with the result of the request

Returns:

a RequestToken to handle the asynchronous request

fetchSync

public static BaasResult<BaasDocument> fetchSync(java.lang.String collection,
                                                 java.lang.String id)

Synchronously fetches a document from the server

Parameters:

collection - the collection to retrieve the document from. Not null

id - the id of the document to retrieve. Not null

Returns:

the result of the request

refreshSync

public BaasResult<BaasDocument> refreshSync()

Synchronously refresh the content of this document

Returns:

the result of the request

Throws:

java.lang.IllegalStateException - if this document has no id

delete

public static RequestToken delete(java.lang.String collection,
                                  java.lang.String id,
                                  BaasHandler<java.lang.Void> handler)

delete

public static RequestToken delete(java.lang.String collection,
                                  java.lang.String id,
                                  int flags,
                                  BaasHandler<java.lang.Void> handler)

deleteSync

public static BaasResult<java.lang.Void> deleteSync(java.lang.String collection,
                                                    java.lang.String id)

save

public RequestToken save(SaveMode mode,
                         int flags,
                         BaasHandler<BaasDocument> handler)

saveSync

public BaasResult<BaasDocument> saveSync(SaveMode mode)

getAuthor

public final java.lang.String getAuthor()

Description copied from class: BaasObject

The username of the owner of this object, or null if this object is new.

Specified by:

getAuthor in class BaasObject

Returns:

a username as String or null

getCollection

public final java.lang.String getCollection()

Returns the collection to which this document belongs.

Returns:

the name of the collection

getId

public final java.lang.String getId()

Description copied from class: BaasObject

The id of this object on the server. New objects created locally have no id.

Specified by:

getId in class BaasObject

Returns:

a uuid as a String or null.

getVersion

public final long getVersion()

Description copied from class: BaasObject

The version number of this object.

Specified by:

getVersion in class BaasObject

Returns:

a long version number

iterator

public java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.Object>> iterator()

Returns an Iterator over the mappings of this document

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>

Returns:

an iterator over the mappings of this document

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

clear

public BaasDocument clear()

Removes all the mappings from this document

Returns:

this document with no mappings

contains

public boolean contains(java.lang.String name)

Checks if this document contains a mapping with name key

Parameters:

name - a non null key

Returns:

true if the document contains the mapping false otherwise

delete

public RequestToken delete(BaasHandler<java.lang.Void> handler)

delete

public RequestToken delete(int flags,
                           BaasHandler<java.lang.Void> handler)

deleteSync

public BaasResult<java.lang.Void> deleteSync()

getArray

public JsonArray getArray(java.lang.String name)

Returns the value mapped to name as a JsonArray or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getArray

public JsonArray getArray(java.lang.String name,
                          JsonArray otherwise)

Returns the value mapped to name as a JsonArray or otherwise if the mapping is absent.

Parameters:

name - a non null key

otherwise - a default value

Returns:

the value mapped to name or otherwise

getBinary

public byte[] getBinary(java.lang.String name)

Returns the value mapped to name as a byte[] array or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getBinary

public byte[] getBinary(java.lang.String name,
                        byte[] otherwise)

Returns the value mapped to name as a byte[] array or otherwise if the mapping is absent.

Parameters:

name - a non null key

otherwise - a default value

Returns:

the value mapped to name or otherwise

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name)

Returns the value mapped to name as a Boolean or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getBoolean

public boolean getBoolean(java.lang.String name,
                          boolean otherwise)

Returns the value mapped to name as a boolean or otherwise if the mapping is absent.

Parameters:

otherwise - a boolean default

name - a non null key

Returns:

the value mapped to name or otherwise

getCreationDate

public final java.lang.String getCreationDate()

Description copied from class: BaasObject

The date this object was created on the server, or null if the object is new.

Specified by:

getCreationDate in class BaasObject

Returns:

a string representation of a date.

getDouble

public java.lang.Double getDouble(java.lang.String name)

Returns the value mapped to name as a Double or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getDouble

public double getDouble(java.lang.String name,
                        double otherwise)

Returns the value mapped to name as a double or otherwise if the mapping is absent.

Parameters:

otherwise - a double default

name - a non null key

Returns:

the value mapped to name or otherwise

fields

public java.util.Set<java.lang.String> fields()

Returns a java.util.Set of all the keys contained in this document

Returns:

a set of the keys contained in this document

getFloat

public java.lang.Float getFloat(java.lang.String name)

Returns the value mapped to name as a Float or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getFloat

public float getFloat(java.lang.String name,
                      float otherwise)

Returns the value mapped to name as a float or otherwise if the mapping is absent.

Parameters:

otherwise - a float default

name - a non null key

Returns:

the value mapped to name or otherwise

getInt

public java.lang.Integer getInt(java.lang.String name)

Returns the value mapped to name as a Integer or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getInt

public int getInt(java.lang.String name,
                  int otherwise)

Returns the value mapped to name as a int or otherwise if the mapping is absent.

Parameters:

otherwise - a int default

name - a non null key

Returns:

the value mapped to name or otherwise

getLong

public java.lang.Long getLong(java.lang.String name)

Returns the value mapped to name as a Long or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getLong

public long getLong(java.lang.String name,
                    long otherwise)

Returns the value mapped to name as a long or otherwise if the mapping is absent.

Parameters:

otherwise - a long default

name - a non null key

Returns:

the value mapped to name or otherwise

getObject

public JsonObject getObject(java.lang.String name)

Returns the value mapped to name as a JsonObject or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getObject

public JsonObject getObject(java.lang.String name,
                            JsonObject otherwise)

Returns the value mapped to name as a JsonObject or otherwise if the mapping is absent.

Parameters:

name - a non null key

otherwise - a default value

Returns:

the value mapped to name or otherwise

getString

public java.lang.String getString(java.lang.String name)

Returns the value mapped to name as a String or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getString

public java.lang.String getString(java.lang.String name,
                                  java.lang.String otherwise)

Returns the value mapped to name as a String or otherwise if the mapping is absent.

Parameters:

name - a non null key

otherwise - a default value

Returns:

the value mapped to name or otherwise

getStructure

public JsonStructure getStructure(java.lang.String name)

Returns the value mapped to name as a JsonStructure or null if the mapping is absent.

Parameters:

name - a non null key

Returns:

the value mapped to name or null

getStructure

public JsonStructure getStructure(java.lang.String name,
                                  JsonStructure otherwise)

Returns the value mapped to name as a JsonStructure or otherwise if the mapping is absent.

Parameters:

name - a non null key

otherwise - a default value

Returns:

the value mapped to name or otherwise

grant

public RequestToken grant(Grant grant,
                          java.lang.String username,
                          int flags,
                          BaasHandler<java.lang.Void> handler)

Description copied from class: BaasObject

Asynchronously grants the access grant to this object to username. The outcome of the request is handed to the provided handler.

Specified by:

grant in class BaasObject

Parameters:

grant - a non null Grant

username - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

grantAll

public RequestToken grantAll(Grant grant,
                             java.lang.String role,
                             int flags,
                             BaasHandler<java.lang.Void> handler)

Description copied from class: BaasObject

Asynchronously grants the access grant to this object to users with role. The outcome of the request is handed to the provided handler.

Specified by:

grantAll in class BaasObject

Parameters:

grant - a non null Grant

role - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

grantAllSync

public BaasResult<java.lang.Void> grantAllSync(Grant grant,
                                               java.lang.String role)

Description copied from class: BaasObject

Synchronously grants the acces grant to this object to all users in role

Specified by:

grantAllSync in class BaasObject

Parameters:

grant - a non null Grant

role - a non null role

Returns:

the outcome of the request wrapped in a BaasResult

grantSync

public BaasResult<java.lang.Void> grantSync(Grant grant,
                                            java.lang.String username)

Description copied from class: BaasObject

Synchronously grants the access grant to this object to username.

Specified by:

grantSync in class BaasObject

Parameters:

grant - a non null Grant

username - a non null username

Returns:

the outcome of the request wrapped in a BaasResult

isNull

public boolean isNull(java.lang.String name)

Checks if name maps explicitly to null

Parameters:

name - a non null key

Returns:

true if the document contains a mapping from name to null false otherwise

merge

public BaasDocument merge(JsonObject other)

Merges the content of other into this document overwriting any mapping for wich other contains a key. Note that other is copied before merging.

Parameters:

other - JsonObject

Returns:

this document with other mappings merged in

put

public BaasDocument put(java.lang.String name,
                        JsonArray value)

Associate name key to the JsonArray value in this document.

Parameters:

name - a non null key

value - a JsonArray

Returns:

this document with the new mapping created

put

public BaasDocument put(java.lang.String name,
                        byte[] value)

Associate name key to the byte[] value in this document. Note that binary data is encoded using base64 and added as strings in the object.

Parameters:

name - a non null key

value - a byte[] array

Returns:

this document with the new mapping created

put

public BaasDocument put(java.lang.String name,
                        boolean value)

Associate name key to the boolean value in this document.

Parameters:

name - a non null key

value - a boolean value

Returns:

this document with the new mapping created

put

public BaasDocument put(java.lang.String name,
                        double value)

Associate name key to the double value in this document.

Parameters:

name - a non null key

value - a double value

Returns:

this document with the new mapping created

put

public BaasDocument put(java.lang.String name,
                        long value)

Associate name key to the long value in this document.

Parameters:

name - a non null key

value - a long value

Returns:

this document with the new mapping created

putNull

public BaasDocument putNull(java.lang.String name)

Puts an explicit mapping to from name to null in this document.

This is different from not having the mapping at all, to completely remove the mapping use instead BaasDocument.remove(String)

Parameters:

name - a non null key

Returns:

this document with the new mapping created

See Also:

BaasDocument.remove(String)

put

public BaasDocument put(java.lang.String name,
                        JsonObject value)

Associate name key to the JsonObject value in this document.

Parameters:

name - a non null key

value - a JsonObject

Returns:

this document with the new mapping created

put

public BaasDocument put(java.lang.String name,
                        java.lang.String value)

Associate name key to the String value in this document.

Parameters:

name - a non null key

value - a String

Returns:

this document with the new mapping created

refresh

public RequestToken refresh(BaasHandler<BaasDocument> handler)

Asynchronously refresh the content of this document.

Parameters:

handler - a callback to be invoked with the result of the request

Returns:

a RequestToken to handle the asynchronous request

Throws:

java.lang.IllegalStateException - if this document has no id

remove

public java.lang.Object remove(java.lang.String name)

Removes the mapping with name key from the document.

Parameters:

name - a non null key

Returns:

the value that was mapped to name if present or null

revoke

public RequestToken revoke(Grant grant,
                           java.lang.String username,
                           int flags,
                           BaasHandler<java.lang.Void> handler)

Description copied from class: BaasObject

Asynchronously revoke the access grant to this object to username. The outcome of the request is handed to the provided handler.

Specified by:

revoke in class BaasObject

Parameters:

grant - a non null Grant

username - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

revokeAll

public RequestToken revokeAll(Grant grant,
                              java.lang.String role,
                              int flags,
                              BaasHandler<java.lang.Void> handler)

Description copied from class: BaasObject

Asynchronously revokes the access grant to this object from users with role. The outcome of the request is handed to the provided handler.

Specified by:

revokeAll in class BaasObject

Parameters:

grant - a non null Grant

role - a non null username

flags - RequestOptions

handler - an handler that will receive the outcome of the request.

Returns:

a RequestToken to manage the asynchronous request

revokeAllSync

public BaasResult<java.lang.Void> revokeAllSync(Grant grant,
                                                java.lang.String role)

Description copied from class: BaasObject

Synchronously revokes the acces grant to this object from all users in role

Specified by:

revokeAllSync in class BaasObject

Parameters:

grant - a non null Grant

role - a non null role

Returns:

the outcome of the request wrapped in a BaasResult

revokeSync

public BaasResult<java.lang.Void> revokeSync(Grant grant,
                                             java.lang.String username)

Description copied from class: BaasObject

Synchronously revokes the access grant to this object from username.

Specified by:

revokeSync in class BaasObject

Parameters:

grant - a non null Grant

username - a non null username

Returns:

the outcome of the request wrapped in a BaasResult

save

public RequestToken save(BaasHandler<BaasDocument> handler)

save

public RequestToken save(SaveMode mode,
                         BaasHandler<BaasDocument> handler)

saveSync

public BaasResult<BaasDocument> saveSync()

size

public int size()

Returns the number of mappings contained in this document.

Returns:

the number of mappings contained in this document.

isDirty

public boolean isDirty()

Specified by:

isDirty in class BaasObject

values

public JsonArray values()

Returns a JsonArray representation of the values contained in this document.

Returns:

a JsonArray representation of the values