io.realm

Enum FieldAttribute

java.lang.Object

java.lang.Enum<FieldAttribute>

io.realm.FieldAttribute

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FieldAttribute>

public enum FieldAttribute
extends java.lang.Enum<FieldAttribute>

This class contains all Realm attributes for a Realm field. These will usually match the annotations found in the io.realm.annotation package. See the relevant annotation for further information on each modifier.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INDEXED Mark a field as indexed.
PRIMARY_KEY Mark a field as a primary key.
REQUIRED Mark a field as explicitly not allowing null values.

Method Summary

Modifier and Type	Method and Description
static FieldAttribute	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FieldAttribute[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INDEXED

public static final FieldAttribute INDEXED

Mark a field as indexed.

See Also:

Index

PRIMARY_KEY

public static final FieldAttribute PRIMARY_KEY

Mark a field as a primary key. This also implicitly mark it as INDEXED.

See Also:

PrimaryKey

REQUIRED

public static final FieldAttribute REQUIRED

Mark a field as explicitly not allowing null values. The default behavior for allowing null depends on the type of the field.

See Also:

Required, RealmObjectSchema.setRequired(String, boolean)

Method Detail

values

public static FieldAttribute[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FieldAttribute c : FieldAttribute.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FieldAttribute valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null