DynamicRealmObject (Realm 5.7.0)

java.lang.Object
- io.realm.RealmObject
- - io.realm.DynamicRealmObject

All Implemented Interfaces:

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

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DynamicRealmObject
```
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.
    
    Throws:
    
    IllegalArgumentException - if object isn't managed by Realm or is a DynamicRealmObject already.
- Method Detail
  - get
```
public <E> E get(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.
  - 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.
    
    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.
    
    RealmException - if the return value would be null.
  - 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.
    
    RealmException - if the return value would be null.
  - 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.
    
    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.
    
    RealmException - if the return value would be null.
  - 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.
    
    RealmException - if the return value would be null.
  - 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.
    
    RealmException - if the return value would be null.
  - 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.
  - 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.
  - 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.
  - 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.
  - getList
```
public RealmList<DynamicRealmObject> getList(String fieldName)
```
    Returns the RealmList of DynamicRealmObjects 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.
  - getList
```
public <E> RealmList<E> getList(String fieldName,
                                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.
  - 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.
  - 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.
  - 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.
  - 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 PrimaryKey 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.
  - 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 PrimaryKey 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 PrimaryKey field.
  - 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 PrimaryKey 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 PrimaryKey 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.
  - 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.
  - 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 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.
  - 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.
  - 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.
  - setList
```
public <E> void setList(String fieldName,
                        RealmList<E> list)
```
    Sets the reference to a RealmList on the given field.
    
    Parameters:
    
    fieldName - field name.
    
    list - list of objects. Must either be primitive types or DynamicRealmObjects.
    
    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.
  - 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 PrimaryKey field.
  - 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.
  - 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.
  - 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(java.lang.Object) 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.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for the object.
    
    See Also:
    
    equals(java.lang.Object)
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - linkingObjects
```
public RealmResults<DynamicRealmObject> 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.
  - getDynamicRealm
```
public DynamicRealm getDynamicRealm()
```
    Returns DynamicRealm instance where this DynamicRealmObject belongs.
    You must not call BaseRealm.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.
  - realm$injectObjectContext
```
public void realm$injectObjectContext()
```
  - realmGet$proxyState
```
public ProxyState realmGet$proxyState()
```

Class DynamicRealmObject

Constructor Summary

Method Summary

Methods inherited from class io.realm.RealmObject

Methods inherited from class java.lang.Object

Constructor Detail

DynamicRealmObject

Method Detail

get

getBoolean

getInt

getShort

getLong

getByte

getFloat

getDouble

getBlob

getString

getDate

getObject

getList

getList

isNull

hasField

getFieldNames

set

setBoolean

setShort

setInt

setLong

setByte

setFloat

setDouble

setString

setBlob

setDate

setObject

setList

setNull

getType

getFieldType

hashCode

equals

toString

linkingObjects

getDynamicRealm

realm$injectObjectContext

realmGet$proxyState