com.quickblox.core.model

Class QBBaseCustomObject

java.lang.Object

com.quickblox.core.model.QBEntity

com.quickblox.core.model.QBBaseCustomObject

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

QBCustomObject, QBDialogCustomData

public abstract class QBBaseCustomObject
extends QBEntity

The base class for custom objects related models.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	className
protected java.util.HashMap<java.lang.String,java.lang.Object>	fields

Fields inherited from class com.quickblox.core.model.QBEntity

createdAt, id, updatedAt

Constructor Summary

Constructors

Constructor and Description
QBBaseCustomObject() Constructs a new QBBaseCustomObject object
QBBaseCustomObject(java.lang.String className) Constructs a new QBBaseCustomObject object

Method Summary

Modifier and Type	Method and Description
void	copyFieldsTo(QBBaseCustomObject baseObject)
java.lang.Object	get(java.lang.String fieldName) Get the value of some field
<T> java.util.List<T>	getArray(java.lang.String fieldName) Gets the array value of a field
java.lang.Boolean	getBoolean(java.lang.String fieldName) Gets the Boolean value of a field
java.lang.String	getClassName() Get the object's class name
java.util.Date	getDate(java.lang.String fieldName, java.text.SimpleDateFormat formatter) Gets the Date value of a field
java.util.HashMap<java.lang.String,java.lang.Object>	getFields() Get the fields of object
java.lang.Float	getFloat(java.lang.String fieldName) Gets the Float value of a field
java.lang.Integer	getInteger(java.lang.String fieldName) Gets the Integer value of a field
java.util.List<java.lang.Double>	getLocation(java.lang.String fieldName) Gets the Location value of a field
java.lang.String	getString(java.lang.String fieldName) Gets the String value of a field
abstract QBBaseCustomObject	put(java.lang.String fieldName, java.lang.Object value) Puts field value where There are few types of class field: Integer String Float Boolean Date Array - array represents as string of values separated by coma symbol.
abstract <E> QBBaseCustomObject	putArray(java.lang.String fieldName, java.util.List<E> value) Puts the array value in field Each array could contains values one of the following type: Integer String Float Boolean In case of set wrong value to array it will be initialize with null value
abstract QBBaseCustomObject	putBoolean(java.lang.String fieldName, boolean value) Puts the Boolean value in field
abstract QBBaseCustomObject	putDate(java.lang.String fieldName, java.util.Date value) Puts the Date value in field
void	putFields(java.util.HashMap<java.lang.String,java.lang.Object> fields) Puts the map with fields and their values
abstract QBBaseCustomObject	putFloat(java.lang.String fieldName, float value) Puts the Float value in field
abstract QBBaseCustomObject	putInteger(java.lang.String fieldName, int value) Puts the Integer value in field
abstract QBBaseCustomObject	putLocation(java.lang.String fieldName, java.util.List<java.lang.Double> value) Puts the Location value in field
abstract QBBaseCustomObject	putString(java.lang.String fieldName, java.lang.String value) Puts the String value in field
java.lang.Object	remove(java.lang.String fieldName) Remove the value of some field
void	setClassName(java.lang.String className) Sets the object's class name
void	setFields(java.util.HashMap<java.lang.String,java.lang.Object> fields) Sets the object's fields
java.lang.String	toString()

Methods inherited from class com.quickblox.core.model.QBEntity

copyFieldsTo, equals, getCreatedAt, getFCreatedAt, getFUpdatedAt, getId, getUpdatedAt, hashCode, setCreatedAt, setId, setUpdatedAt

Methods inherited from class java.lang.Object

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

Field Detail

className

protected java.lang.String className

fields

protected java.util.HashMap<java.lang.String,java.lang.Object> fields

Constructor Detail

QBBaseCustomObject

public QBBaseCustomObject()

Constructs a new QBBaseCustomObject object

QBBaseCustomObject

public QBBaseCustomObject(java.lang.String className)

Constructs a new QBBaseCustomObject object

Parameters:

className - the class name of the object related to

Method Detail

getClassName

public java.lang.String getClassName()

Get the object's class name

setClassName

public void setClassName(java.lang.String className)

Sets the object's class name

Parameters:

className - the name to set

getFields

public java.util.HashMap<java.lang.String,java.lang.Object> getFields()

Get the fields of object

setFields

public void setFields(java.util.HashMap<java.lang.String,java.lang.Object> fields)

Sets the object's fields

Parameters:

fields - the fields map to set

putFields

public void putFields(java.util.HashMap<java.lang.String,java.lang.Object> fields)

Puts the map with fields and their values

Parameters:

fields - the map with fields and their values

get

public java.lang.Object get(java.lang.String fieldName)

Get the value of some field

Parameters:

fieldName - the name of field

remove

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

Remove the value of some field

Parameters:

fieldName - the name of field

put

public abstract QBBaseCustomObject put(java.lang.String fieldName,
                                       java.lang.Object value)

Puts field value where There are few types of class field:

• Integer
• String
• Float
• Boolean
• Date
• Array - array represents as string of values separated by coma symbol. \n Array values could be next types^ Integer, String, Float, Boolean
• Location - array with 2 elements: longitude, latitude

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBBaseCustomObject instance to chain operations

putInteger

public abstract QBBaseCustomObject putInteger(java.lang.String fieldName,
                                              int value)

Puts the Integer value in field

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBBaseCustomObject instance to chain operations

getInteger

public java.lang.Integer getInteger(java.lang.String fieldName)
                             throws java.lang.NumberFormatException

Gets the Integer value of a field

Parameters:

fieldName - The name of field

Returns:

the value of a field or null if the value can't be parsed to Integer.

Throws:

java.lang.NumberFormatException

putString

public abstract QBBaseCustomObject putString(java.lang.String fieldName,
                                             java.lang.String value)

Puts the String value in field

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBBaseCustomObject instance to chain operations

getString

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

Gets the String value of a field

Parameters:

fieldName - The name of field

Returns:

the value of a field or null if the value can't be parsed to String.

putFloat

public abstract QBBaseCustomObject putFloat(java.lang.String fieldName,
                                            float value)

Puts the Float value in field

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBBaseCustomObject instance to chain operations

getFloat

public java.lang.Float getFloat(java.lang.String fieldName)
                         throws java.lang.NumberFormatException

Gets the Float value of a field

Parameters:

fieldName - The name of field

Returns:

the value of a field or null if the value can't be parsed to Float.

Throws:

java.lang.NumberFormatException

putBoolean

public abstract QBBaseCustomObject putBoolean(java.lang.String fieldName,
                                              boolean value)

Puts the Boolean value in field

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBBaseCustomObject instance to chain operations

getBoolean

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

Gets the Boolean value of a field

Parameters:

fieldName - The name of field

Returns:

the value of a field or null if the value can't be parsed to Boolean.

putDate

public abstract QBBaseCustomObject putDate(java.lang.String fieldName,
                                           java.util.Date value)

Puts the Date value in field

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBBaseCustomObject instance to chain operations

getDate

public java.util.Date getDate(java.lang.String fieldName,
                              java.text.SimpleDateFormat formatter)
                       throws java.text.ParseException

Gets the Date value of a field

Parameters:

fieldName - The name of field

formatter - SimpleDateFormat object

Returns:

the value of a field or null if the value can't be parsed to Date.

Throws:

java.text.ParseException

putLocation

public abstract QBBaseCustomObject putLocation(java.lang.String fieldName,
                                               java.util.List<java.lang.Double> value)

Puts the Location value in field

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBBaseCustomObject instance to chain operations

getLocation

public java.util.List<java.lang.Double> getLocation(java.lang.String fieldName)
                                             throws java.lang.NumberFormatException

Gets the Location value of a field

Parameters:

fieldName - The name of field

Returns:

the value of a field or null if the value can't be parsed to Location.

Throws:

java.lang.NumberFormatException

putArray

public abstract <E> QBBaseCustomObject putArray(java.lang.String fieldName,
                                                java.util.List<E> value)

Puts the array value in field Each array could contains values one of the following type:

• Integer
• String
• Float
• Boolean
• In case of set wrong value to array it will be initialize with null value

Parameters:

fieldName - The name of field

value - The value of field

Returns:

QBBaseCustomObject instance to chain operations

getArray

public <T> java.util.List<T> getArray(java.lang.String fieldName)

Gets the array value of a field

Parameters:

fieldName - The name of field

Returns:

the value of a field or null if the value can't be parsed to array.

toString

public java.lang.String toString()

Overrides:

toString in class QBEntity

copyFieldsTo

public void copyFieldsTo(QBBaseCustomObject baseObject)