org.nuxeo.box.api.marshalling.dao

Class BoxObject

java.lang.Object

org.nuxeo.box.api.marshalling.dao.BoxBase

org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

org.nuxeo.box.api.marshalling.dao.BoxObject

All Implemented Interfaces:

IBoxJSONStringEntity

Direct Known Subclasses:

BoxCollectionBase, BoxEmail, BoxEnterprise, BoxPreview, BoxServiceAction, BoxSharedLink, BoxSharedLinkPermissions, BoxTypedObject

public class BoxObject
extends DefaultJSONStringEntity

Constructor Summary

Constructors

Constructor and Description
BoxObject()
BoxObject(BoxObject obj) Copy constructor, this does deep copy for all the fields.
BoxObject(Map<String,Object> map) Instantiate the object from a map.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String key) Use this method to check whether the object contains certain field at all.
boolean	equals(Object obj) Whether the two objects are equal.
Object	getExtraData(String key) Get extra data.
Set<String>	getKeySet() Added to introspect the map to update document
Object	getValue(String key)
void	handleUnknown(String key, Object value)
int	hashCode()
Map<String,Object>	properties()
void	put(String key, Object value)
void	putAll(Map<String,Object> newMap)

Methods inherited from class org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

toJSONString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxObject

public BoxObject()

BoxObject

public BoxObject(Map<String,Object> map)

Instantiate the object from a map. Each entry in the map reflects to a field.

Parameters:

map -

BoxObject

public BoxObject(BoxObject obj)

Copy constructor, this does deep copy for all the fields.

Parameters:

obj -

Method Detail

equals

public boolean equals(Object obj)

Whether the two objects are equal. This strictly compares all the fields in the two objects, if any fields are different this returns false.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

Whether the two objects are equal.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

put

public void put(String key,
       Object value)

putAll

public void putAll(Map<String,Object> newMap)

getValue

public Object getValue(String key)

getExtraData

public Object getExtraData(String key)

Get extra data. This could be extra unknown data passed back from api responses, the data is put in a Map.

Parameters:

key -

Returns:

extra object

properties

public Map<String,Object> properties()

contains

public boolean contains(String key)

Use this method to check whether the object contains certain field at all. This helps differentiate the case when the field is not returned from server at all, or is returned from server but value is null. For the first case, this method returns false, the later case returns true.

Returns:

whether the field exists

handleUnknown

public void handleUnknown(String key,
                 Object value)

getKeySet

public Set<String> getKeySet()

Added to introspect the map to update document

Since:

5.9.2