Class DynamicRealmObject

Atlas Device SDKs are deprecated. Refer to the deprecation page for details.

io.realm

java.lang.Object

io.realm.RealmObject

io.realm.DynamicRealmObject

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 RealmObject class.

Constructors

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

Method Summary

Modifier and Type	Method and Description
public boolean	equals ( Object o )
public E	get <E >( String fieldName ) Returns the value for the given field.
public byte	getBlob ( String fieldName ) Returns the `byte[]` value for a given field.
public boolean	getBoolean ( String fieldName ) Returns the `boolean` value for a given field.
public byte	getByte ( String fieldName ) Returns the `byte` value for a given field.
public Date	getDate ( String fieldName ) Returns the `Date` value for a given field.
public Decimal128	getDecimal128 ( String fieldName ) Returns the `Decimal128` value for a given field.
public RealmDictionary	getDictionary <E >( String fieldName, java.lang.Class<E> primitiveType ) Returns the RealmDictionary containing only primitive values.
public RealmDictionary	getDictionary ( String fieldName ) Returns the RealmDictionary of DynamicRealmObject s being linked from the given field.
public double	getDouble ( String fieldName ) Returns the `double` value for a given field.
public DynamicRealm	getDynamicRealm () Returns DynamicRealm instance where this DynamicRealmObject belongs.
public String	getFieldNames () Returns the list of field names on this object.
public RealmFieldType	getFieldType ( String fieldName ) Returns the type used by the underlying storage engine to represent this field.
public float	getFloat ( String fieldName ) Returns the `float` value for a given field.
public int	getInt ( String fieldName ) Returns the `int` value for a given field.
public RealmList	getList <E >( String fieldName, java.lang.Class<E> primitiveType ) Returns the RealmList containing only primitive values.
public RealmList	getList ( String fieldName ) Returns the RealmList of DynamicRealmObject s being linked from the given field.
public long	getLong ( String fieldName ) Returns the `long` value for a given field.
public DynamicRealmObject	getObject ( String fieldName ) Returns the object being linked to from this field.
public ObjectId	getObjectId ( String fieldName ) Returns the `ObjectId` value for a given field.
public RealmAny	getRealmAny ( String fieldName ) Returns the `RealmAny` value for a given field.
public RealmSet	getRealmSet <E >( String fieldName, java.lang.Class<E> primitiveType ) Returns the RealmSet containing only primitive values.
public RealmSet	getRealmSet ( String fieldName ) Returns the RealmSet of DynamicRealmObject s being linked from the given field.
public short	getShort ( String fieldName ) Returns the `short` value for a given field.
public String	getString ( String fieldName ) Returns the `String` value for a given field.
public String	getType () Returns the type of object.
public UUID	getUUID ( String fieldName ) Returns the `UUID` value for a given field.
public boolean	hasField ( String fieldName ) Checks whether an object has the given field or not.
public int	hashCode () Returns a hash code value for the DynamicRealmObject object.
public boolean	isNull ( String fieldName ) Checks if the value of a given field is `null` .
public RealmResults	linkingObjects ( String srcClassName, String srcFieldName ) Returns RealmResults containing all `srcClassName` class objects that have a relationship to this object from `srcFieldName` field.
public void	realm$injectObjectContext ()
public ProxyState	realmGet$proxyState ()
public void	set ( String fieldName, Object value ) Sets the value for the given field.
public void	setBlob ( String fieldName, byte[] value ) Sets the binary value of the given field.
public void	setBoolean ( String fieldName, boolean value ) Sets the `boolean` value of the given field.
public void	setByte ( String fieldName, byte value ) Sets the `byte` value of the given field.
public void	setDate ( String fieldName, Date value ) Sets the `Date` value of the given field.
public void	setDecimal128 ( String fieldName, Decimal128 value ) Sets the `Decimal128` value of the given field.
public void	setDictionary <E >( String fieldName, io.realm.RealmDictionary<E> dictionary ) Sets the reference to a RealmDictionary on the given field.
public void	setDouble ( String fieldName, double value ) Sets the `double` value of the given field.
public void	setFloat ( String fieldName, float value ) Sets the `float` value of the given field.
public void	setInt ( String fieldName, int value ) Sets the `int` value of the given field.
public void	setList <E >( String fieldName, io.realm.RealmList<E> list ) Sets the reference to a RealmList on the given field.
public void	setLong ( String fieldName, long value ) Sets the `long` value of the given field.
public void	setNull ( String fieldName ) Sets the value to `null` for the given field.
public void	setObject ( String fieldName, DynamicRealmObject value ) Sets a reference to another object on the given field.
public void	setObjectId ( String fieldName, ObjectId value ) Sets the `ObjectId` value of the given field.
public void	setRealmAny ( String fieldName, RealmAny value ) Sets the `RealmAny` value of the given field.
public void	setRealmSet <E >( String fieldName, io.realm.RealmSet<E> set ) Sets the reference to a RealmSet on the given field.
public void	setShort ( String fieldName, short value ) Sets the `short` value of the given field.
public void	setString ( String fieldName, String value ) Sets the `String` value of the given field.
public void	setUUID ( String fieldName, UUID value ) Sets the `UUID` value of the given field.
public String	toString ()

Inherited Methods

Methods inherited from class java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize
Methods inherited from class io.realm.RealmObject : deleteFromRealm , deleteFromRealm , isValid , isValid , isFrozen , freeze , isFrozen , freeze , isLoaded , isLoaded , isManaged , isManaged , getRealm , getRealm , load , load , addChangeListener , addChangeListener , addChangeListener , addChangeListener , removeChangeListener , removeChangeListener , removeChangeListener , removeChangeListener , removeAllChangeListeners , removeAllChangeListeners , asFlowable , asChangesetObservable , asFlowable , asChangesetObservable

Constructor Detail

public DynamicRealmObject ( RealmModel obj )
Creates a dynamic Realm object based on an existing object. Parameters `obj` - the Realm object to convert to a dynamic object. Only objects managed by Realm can be used.

Method Detail

equals

public boolean equals ( Object o )
Overrides `equals` in class Object

get

public E get <E >( String fieldName )
Returns the value for the given field. Parameters `fieldName` - name of the field. Returns the field value. Throws ClassCastException - if the field doesn't contain a field of the defined return type.

getBlob

public byte getBlob ( String fieldName )
Returns the `byte[]` value for a given field. Parameters `fieldName` - the name of the field. Returns the byte[] value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain binary data.

getBoolean

public boolean getBoolean ( String fieldName )
Returns the `boolean` value for a given field. If the field is nullable, use isNull(String) to check for `null` instead of using this method. Parameters `fieldName` - the name of the field. Returns the boolean value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain booleans. io.realm.exceptions.RealmException - if the return value would be `null` .

getByte

public byte getByte ( String fieldName )
Returns the `byte` value for a given field. If the field is nullable, use isNull(String) to check for `null` instead of using this method. Parameters `fieldName` - the name of the field. Returns the byte value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain integers. io.realm.exceptions.RealmException - if the return value would be `null` .

getDate

public Date getDate ( String fieldName )
Returns the `Date` value for a given field. Parameters `fieldName` - the name of the field. Returns the Date value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain Dates.

getDecimal128

public Decimal128 getDecimal128 ( String fieldName )
Returns the `Decimal128` value for a given field. Parameters `fieldName` - the name of the field. Returns the Decimal128 value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain Decimal128.

getDictionary

public RealmDictionary getDictionary <E >(

String fieldName,

java.lang.Class<E> primitiveType

)

Returns the RealmDictionary containing only primitive values.

If the dictionary contains references to other Realm objects, use getDictionary(String) instead.

Parameters

fieldName - the name of the field.
primitiveType - the type of elements in the dictionary. Only primitive types are supported.

Returns

the RealmDictionary data for this field.

Throws

IllegalArgumentException - if field name doesn't exist or it doesn't contain a dictionary of primitive objects.

public RealmDictionary getDictionary ( String fieldName )
Returns the RealmDictionary of DynamicRealmObject s being linked from the given field. If the dictionary contains primitive types, use getDictionary(String, Class) instead. Parameters `fieldName` - the name of the field. Returns the RealmDictionary data for this field. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain a dictionary of objects.

getDouble

public double getDouble ( String fieldName )
Returns the `double` value for a given field. If the field is nullable, use isNull(String) to check for `null` instead of using this method. Parameters `fieldName` - the name of the field. Returns the double value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain doubles. io.realm.exceptions.RealmException - if the return value would be `null` .

getDynamicRealm

public DynamicRealm getDynamicRealm ()
Returns DynamicRealm instance where this DynamicRealmObject belongs. You must not call DynamicRealm.close() against returned instance. Returns DynamicRealm instance where this object belongs. Throws IllegalStateException - if this object was deleted or the corresponding DynamicRealm was already closed.

getFieldNames

public 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.

getFieldType

public RealmFieldType getFieldType ( String fieldName )
Returns the type used by the underlying storage engine to represent this field. Returns the underlying type used by Realm to represent this field.

getFloat

public float getFloat ( String fieldName )
Returns the `float` value for a given field. If the field is nullable, use isNull(String) to check for `null` instead of using this method. Parameters `fieldName` - the name of the field. Returns the float value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain floats. io.realm.exceptions.RealmException - if the return value would be `null` .

getInt

public int getInt (

String fieldName

)

Returns the int value for a given field.

If the field is nullable, use isNull(String) to check for null instead of using this method.

Parameters

fieldName - the name of the field.

Returns

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

Throws

IllegalArgumentException - if field name doesn't exist or it doesn't contain integers.
io.realm.exceptions.RealmException - if the return value would be null .

getList

public RealmList getList <E >(

String fieldName,

java.lang.Class<E> primitiveType

)

Returns the RealmList containing only primitive values.

If the list contains references to other Realm objects, use getList(String) instead.

Parameters

fieldName - the name of the field.
primitiveType - the type of elements in the list. Only primitive types are supported.

Returns

the RealmList data for this field.

Throws

IllegalArgumentException - if field name doesn't exist or it doesn't contain a list of primitive objects.

public RealmList getList ( String fieldName )
Returns the RealmList of DynamicRealmObject s being linked from the given field. If the list contains primitive types, use getList(String, Class) instead. Parameters `fieldName` - the name of the field. Returns the RealmList data for this field. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain a list of objects.

getLong

public long getLong (

String fieldName

)

Returns the long value for a given field.

If the field is nullable, use isNull(String) to check for null instead of using this method.

Parameters

fieldName - the name of the field.

Returns

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

Throws

IllegalArgumentException - if field name doesn't exist or it doesn't contain integers.
io.realm.exceptions.RealmException - if the return value would be null .

getObject

public DynamicRealmObject getObject ( String fieldName )
Returns the object being linked to from this field. Parameters `fieldName` - the name of the field. Returns the DynamicRealmObject representation of the linked object or `null` if no object is linked. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain links to other objects.

getObjectId

public ObjectId getObjectId ( String fieldName )
Returns the `ObjectId` value for a given field. Parameters `fieldName` - the name of the field. Returns the ObjectId value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain ObjectId.

getRealmAny

public RealmAny getRealmAny ( String fieldName )
Returns the `RealmAny` value for a given field. Parameters `fieldName` - the name of the field. Returns the RealmAny value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain RealmAny.

getRealmSet

public RealmSet getRealmSet <E >(

String fieldName,

java.lang.Class<E> primitiveType

)

Returns the RealmSet containing only primitive values.

If the set contains references to other Realm objects, use getRealmSet(String) instead.

Parameters

fieldName - the name of the field.
primitiveType - the type of elements in the set. Only primitive types are supported.

Returns

the RealmSet data for this field.

Throws

IllegalArgumentException - if field name doesn't exist or it doesn't contain a set of primitive objects.

public RealmSet getRealmSet ( String fieldName )
Returns the RealmSet of DynamicRealmObject s being linked from the given field. If the set contains primitive types, use getRealmSet(String, Class) instead. Parameters `fieldName` - the name of the field. Returns the RealmSet data for this field. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain a set of objects.

getShort

public short getShort (

String fieldName

)

Returns the short value for a given field.

If the field is nullable, use isNull(String) to check for null instead of using this method.

Parameters

fieldName - the name of the field.

Returns

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

Throws

IllegalArgumentException - if field name doesn't exist or it doesn't contain integers.
io.realm.exceptions.RealmException - if the return value would be null .

getString

public String getString ( String fieldName )
Returns the `String` value for a given field. Parameters `fieldName` - the name of the field. Returns the String value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain Strings.

getType

public String getType ()
Returns the type of object. This will normally correspond to the name of a class that is extending RealmObject . Returns this objects type.

getUUID

public UUID getUUID ( String fieldName )
Returns the `UUID` value for a given field. Parameters `fieldName` - the name of the field. Returns the UUID value. Throws IllegalArgumentException - if field name doesn't exist or it doesn't contain UUID.

hasField

public boolean hasField ( String fieldName )
Checks whether an object has the given field or not. Parameters `fieldName` - field name to check. Returns `true` if the object has a field with the given name, `false` otherwise.

hashCode

public int hashCode ()

Returns a hash code value for the DynamicRealmObject object.

By the general contract of Object.hashCode() , any two objects for which equals returns true must return the same hash code value.

Note that a RealmObject is a live object, and it might be updated by changes from other threads. This means that a hash code value of the object is not stable, and the value should be neither used as a key in HashMap nor saved in HashSet.

Returns

a hash code value for the object.

Overrides

hashCode in class Object

Tip

isNull

public boolean isNull ( String fieldName )
Checks if the value of a given field is `null` . Parameters `fieldName` - the name of the field. Returns `true` if field value is null, `false` otherwise. Throws IllegalArgumentException - if field name doesn't exist.

linkingObjects

public RealmResults linkingObjects (

String srcClassName,

String srcFieldName

)

Returns RealmResults containing all srcClassName class objects that have a relationship to this object from srcFieldName field.

An entry is added for each reference, e.g. if the same reference is in a list multiple times, the src object will show up here multiple times.

Parameters

srcClassName - name of the class returned objects belong to.
srcFieldName - name of the field in the source class that holds a reference to this object. Field type must be either io.realm.RealmFieldType.OBJECT or io.realm.RealmFieldType.LIST .

Returns

the result.

Throws

IllegalArgumentException - if the srcClassName is null or does not exist, the srcFieldName is null or does not exist, type of the source field is not supported.

realm$injectObjectContext

public void realm$injectObjectContext ()

realmGet$proxyState

public ProxyState realmGet$proxyState ()

set

public void set (

String fieldName,

Object value

)

Sets the value for the given field. This method will automatically try to convert numbers and booleans that are given as String to their appropriate type. For example "10" will be converted to 10 if the field type is int .

Using the typed setters will be faster than using this method.

Throws

IllegalArgumentException - if field name doesn't exist or if the input value cannot be converted to the appropriate input type.
NumberFormatException - if a String based number cannot be converted properly.
RealmException - if the field is a io.realm.annotations.PrimaryKey field.

setBlob

public void setBlob ( String fieldName, byte[] value )
Sets the binary value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a binary field.

setBoolean

public void setBoolean ( String fieldName, boolean value )
Sets the `boolean` value of the given field. Parameters `fieldName` - field name to update. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a boolean field.

setByte

public void setByte ( String fieldName, byte value )
Sets the `byte` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't an integer field. RealmException - if the field is a io.realm.annotations.PrimaryKey field.

setDate

public void setDate ( String fieldName, Date value )
Sets the `Date` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a Date field.

setDecimal128

public void setDecimal128 ( String fieldName, Decimal128 value )
Sets the `Decimal128` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a Decimal128 field.

setDictionary

public void setDictionary <E >(

String fieldName,

io.realm.RealmDictionary<E> dictionary

)

Sets the reference to a RealmDictionary on the given field.

This will copy all the elements in the dictionary into Realm, but any further changes to the dictionary will not be reflected in the Realm. Use getDictionary(String) in order to get a reference to the managed dictionary.

Parameters

fieldName - field name.
dictionary - dictionary of objects. Must either be primitive types or DynamicRealmObject s.

Throws

IllegalArgumentException - if field name doesn't exist, it is not a dictionary field, the objects in the dictionary doesn't match the expected type or any Realm object in the dictionary belongs to a different Realm.

setDouble

public void setDouble ( String fieldName, double value )
Sets the `double` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a double field.

setFloat

public void setFloat ( String fieldName, float value )
Sets the `float` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a float field.

setInt

public void setInt ( String fieldName, int value )
Sets the `int` value of the given field. Parameters `fieldName` - field name to update. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't an integer field. RealmException - if the field is a io.realm.annotations.PrimaryKey field.

setList

public void setList <E >(

String fieldName,

io.realm.RealmList<E> list

)

Sets the reference to a RealmList on the given field.

This will copy all the elements in the list into Realm, but any further changes to the list will not be reflected in the Realm. Use getList(String) in order to get a reference to the managed list.

Parameters

fieldName - field name.
list - list of objects. Must either be primitive types or DynamicRealmObject s.

Throws

IllegalArgumentException - if field name doesn't exist, it is not a list field, the objects in the list doesn't match the expected type or any Realm object in the list belongs to a different Realm.

setLong

public void setLong ( String fieldName, long value )
Sets the `long` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't an integer field. RealmException - if the field is a io.realm.annotations.PrimaryKey field.

setNull

public void setNull ( String fieldName )
Sets the value to `null` for the given field. Parameters `fieldName` - field name. Throws IllegalArgumentException - if field name doesn't exist, or the field isn't nullable. RealmException - if the field is a io.realm.annotations.PrimaryKey field.

setObject

public void setObject ( String fieldName, DynamicRealmObject value )
Sets a reference to another object on the given field. Parameters `fieldName` - field name. `value` - object to link to. Throws IllegalArgumentException - if field name doesn't exist, it doesn't link to other Realm objects, the type of DynamicRealmObject doesn't match or it belongs to a different Realm.

setObjectId

public void setObjectId ( String fieldName, ObjectId value )
Sets the `ObjectId` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a ObjectId field.

setRealmAny

public void setRealmAny ( String fieldName, RealmAny value )
Sets the `RealmAny` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a RealmAny field.

setRealmSet

public void setRealmSet <E >(

String fieldName,

io.realm.RealmSet<E> set

)

Sets the reference to a RealmSet on the given field.

This will copy all the elements in the set into Realm, but any further changes to the set will not be reflected in the Realm. Use getRealmSet(String) in order to get a reference to the managed set.

Parameters

fieldName - field name.
set - set of objects. Must either be primitive types or DynamicRealmObject s.

Throws

IllegalArgumentException - if field name doesn't exist, it is not a set field, the objects in the set doesn't match the expected type or any Realm object in the set belongs to a different Realm.

setShort

public void setShort ( String fieldName, short value )
Sets the `short` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't an integer field. RealmException - if the field is a io.realm.annotations.PrimaryKey field.

setString

public void setString ( String fieldName, String value )
Sets the `String` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a String field. RealmException - if the field is a io.realm.annotations.PrimaryKey field.

setUUID

public void setUUID ( String fieldName, UUID value )
Sets the `UUID` value of the given field. Parameters `fieldName` - field name. `value` - value to insert. Throws IllegalArgumentException - if field name doesn't exist or field isn't a UUID field.

toString

public String toString ()
Overrides `toString` in class Object

Back

DynamicRealm.Transaction.OnSuccess

FieldAttribute

io.realm

Constructors

Method Summary

Inherited Methods

Constructor Detail

Method Detail

equals

get

getBlob

getBoolean

getByte

getDate

getDecimal128

getDictionary

getDouble

getDynamicRealm

getFieldNames

getFieldType

getFloat

getInt

getList

getLong

getObject

getObjectId

getRealmAny

getRealmSet

getShort

getString

getType

getUUID

hasField

hashCode

Tip

See also:

isNull

linkingObjects

realm$injectObjectContext

realmGet$proxyState

set

setBlob

setBoolean

setByte

setDate

setDecimal128

setDictionary

setDouble

setFloat

setInt

setList

setLong

setNull

setObject

setObjectId

setRealmAny

setRealmSet

setShort

setString

setUUID

toString