io.realm.dynamic

Class DynamicRealmObject

java.lang.Object

io.realm.RealmObject

io.realm.dynamic.DynamicRealmObject

public class DynamicRealmObject
extends RealmObject

Class that wraps a normal RealmObject in order to allow dynamic access instead of a typed interface. Using a DynamicRealmObject is slower than using the regular model class.

Constructor Summary

Constructors

Constructor and Description
DynamicRealmObject(RealmObject obj) Creates a dynamic Realm object based on a existing object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
byte[]	getBlob(java.lang.String fieldName) Returns the byte[] value for a given field.
boolean	getBoolean(java.lang.String fieldName) Returns the boolean value for a given field.
byte	getByte(java.lang.String fieldName) Returns the byte value for a given field.
java.util.Date	getDate(java.lang.String fieldName) Returns the Date value for a given field.
double	getDouble(java.lang.String fieldName) Returns the double value for a given field.
java.lang.String[]	getFieldNames() Returns the list of field names on this object.
float	getFloat(java.lang.String fieldName) Returns the float value for a given field.
int	getInt(java.lang.String fieldName) Returns the int value for a given field.
DynamicRealmList	getList(java.lang.String fieldName) Returns the RealmList of objects being linked to from this field.
long	getLong(java.lang.String fieldName) Returns the long value for a given field.
DynamicRealmObject	getObject(java.lang.String fieldName) Returns the object being linked to from this field.
short	getShort(java.lang.String fieldName) Returns the short value for a given field.
java.lang.String	getString(java.lang.String fieldName) Returns the String value for a given field.
java.lang.String	getType() Return the type of object.
boolean	hasField(java.lang.String fieldName) Checks whether an object has the given field or not.
int	hashCode()
boolean	isNull(java.lang.String fieldName) Checks if the value of a given field is null.
void	removeFromRealm() Deletes this object from the Realm.
void	setBlob(java.lang.String fieldName, byte[] value) Sets the binary value of the given field.
void	setBoolean(java.lang.String fieldName, boolean value) Sets the boolean value of the given field.
void	setByte(java.lang.String fieldName, byte value) Sets the byte value of the given field.
void	setDate(java.lang.String fieldName, java.util.Date value) Sets the Date value of the given field.
void	setDouble(java.lang.String fieldName, double value) Sets the double value of the given field.
void	setFloat(java.lang.String fieldName, float value) Sets the float value of the given field.
void	setInt(java.lang.String fieldName, int value) Sets the int value of the given field.
void	setList(java.lang.String fieldName, DynamicRealmList list) Sets the reference to a DynamicRealmList on the given field.
void	setLong(java.lang.String fieldName, long value) Sets the long value of the given field.
void	setObject(java.lang.String fieldName, DynamicRealmObject value) Sets a reference to another object on the given field.
void	setShort(java.lang.String fieldName, short value) Sets the short value of the given field.
void	setString(java.lang.String fieldName, java.lang.String value) Sets the String value of the given field.
java.lang.String	toString()

Methods inherited from class io.realm.RealmObject

addChangeListener, isLoaded, isValid, load, removeChangeListener, removeChangeListeners

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DynamicRealmObject

public DynamicRealmObject(RealmObject obj)

Creates a dynamic Realm object based on a existing object.

Parameters:

obj - the Realm object to convert to a dynamic object. Only objects managed by Realm can be used.

Throws:

java.lang.IllegalArgumentException - if object isn't managed by a Realm.

Method Detail

getBoolean

public boolean getBoolean(java.lang.String fieldName)

Returns the boolean value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the boolean value.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain booleans.

getInt

public int getInt(java.lang.String fieldName)

Returns the int value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the int value. Integer values exceeding Integer.MAX_VALUE will wrap.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain integers.

getShort

public short getShort(java.lang.String fieldName)

Returns the short value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the short value. Integer values exceeding Short.MAX_VALUE will wrap.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain integers.

getLong

public long getLong(java.lang.String fieldName)

Returns the long value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the long value. Integer values exceeding Long.MAX_VALUE will wrap.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain integers.

getByte

public byte getByte(java.lang.String fieldName)

Returns the byte value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the byte value.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain integers.

getFloat

public float getFloat(java.lang.String fieldName)

Returns the float value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the float value.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain floats.

getDouble

public double getDouble(java.lang.String fieldName)

Returns the double value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the double value.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain doubles.

getBlob

public byte[] getBlob(java.lang.String fieldName)

Returns the byte[] value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the byte[] value.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain binary data.

getString

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

Returns the String value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the string value.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain Strings.

getDate

public java.util.Date getDate(java.lang.String fieldName)

Returns the Date value for a given field.

Parameters:

fieldName - the name of field.

Returns:

the Date value.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain Dates.

getObject

public DynamicRealmObject getObject(java.lang.String fieldName)

Returns the object being linked to from this field.

Parameters:

fieldName - Name of field.

Returns:

the DynamicRealmObject representation of the linked object or null if no object is linked.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain links to other objects.

getList

public DynamicRealmList getList(java.lang.String fieldName)

Returns the RealmList of objects being linked to from this field. This list is returned as a DynamicRealmList.

Parameters:

fieldName - the name of field.

Returns:

the DynamicRealmList representation of the RealmList.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or it doesn't contain a list of links.

isNull

public boolean isNull(java.lang.String fieldName)

Checks if the value of a given field is null.

Parameters:

fieldName - the name of field.

Returns:

true if field value is null, false otherwise.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists.

hasField

public boolean hasField(java.lang.String fieldName)

Checks whether an object has the given field or not.

Parameters:

fieldName - the field name to check.

Returns:

true if the object has a field with the given name, false otherwise.

getFieldNames

public java.lang.String[] getFieldNames()

Returns the list of field names on this object.

Returns:

list of field names on this objects or the empty list if the object doesn't have any fields.

setBoolean

public void setBoolean(java.lang.String fieldName,
              boolean value)

Sets the boolean value of the given field.

Parameters:

fieldName - the field name to update.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't a boolean field.

setShort

public void setShort(java.lang.String fieldName,
            short value)

Sets the short value of the given field.

Parameters:

fieldName - the field name.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't an integer field.

setInt

public void setInt(java.lang.String fieldName,
          int value)

Sets the int value of the given field.

Parameters:

fieldName - the field name to update.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't an integer field.

setLong

public void setLong(java.lang.String fieldName,
           long value)

Sets the long value of the given field.

Parameters:

fieldName - the field name.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't an integer field.

setByte

public void setByte(java.lang.String fieldName,
           byte value)

Sets the byte value of the given field.

Parameters:

fieldName - the field name.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't an integer field.

setFloat

public void setFloat(java.lang.String fieldName,
            float value)

Sets the float value of the given field.

Parameters:

fieldName - the field name.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't an integer field.

setDouble

public void setDouble(java.lang.String fieldName,
             double value)

Sets the double value of the given field.

Parameters:

fieldName - the field name.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't a double field.

setString

public void setString(java.lang.String fieldName,
             java.lang.String value)

Sets the String value of the given field.

Parameters:

fieldName - the field name.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't a String field.

setBlob

public void setBlob(java.lang.String fieldName,
           byte[] value)

Sets the binary value of the given field.

Parameters:

fieldName - the field name.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't a binary field.

setDate

public void setDate(java.lang.String fieldName,
           java.util.Date value)

Sets the Date value of the given field.

Parameters:

fieldName - the field name.

value - the value to insert.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists or isn't a Date field.

setObject

public void setObject(java.lang.String fieldName,
             DynamicRealmObject value)

Sets a reference to another object on the given field.

Parameters:

fieldName - the field name.

value - the object to link to.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists, it doesn't link to other Realm objects, or the type of DynamicRealmObject doesn't match.

setList

public void setList(java.lang.String fieldName,
           DynamicRealmList list)

Sets the reference to a DynamicRealmList on the given field.

Parameters:

fieldName - the field name.

list - the list of references.

Throws:

java.lang.IllegalArgumentException - if field name doesn't exists, it doesn't contain a list of links or the type of the object represented by the DynamicRealmObject doesn't match.

removeFromRealm

public void removeFromRealm()

Deletes this object from the Realm. Accessing any fields after removing the object will throw an IllegalStateException.

Overrides:

removeFromRealm in class RealmObject

getType

public java.lang.String getType()

Return the type of object. This will normally correspond to the name of a model class that is extending RealmObject.

Returns:

this objects type.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object