Package com.elide.model

Enum Class FieldType

java.lang.Object
java.lang.Enum<FieldType>
com.elide.model.FieldType
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<FieldType>, Constable
public enum FieldType extends Enum<FieldType> implements com.google.protobuf.ProtocolMessageEnum
 Enumerates field handling special-cases. Fields may be annotated with these special types to change the way they are
 handled by the model mapping layer.
Protobuf enum elide.model.FieldType

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    FLAGS
    Store this object as a special flags-style mapping.
    ID
    This is an ID field that should be used as the final name of this document.
    KEY
    This is a key field (a primary key sub-message) for a GROUP or COLLECTION-mode message.
    PARENT
    This field represents a key for this item's parent.
    PATH
    This field represents a full key path in hierarchical storage.
    REFERENCE
    This key is a foreign reference.
    STANDARD
    This is a standard field (default value).
    TAGS
    This is a tags-style field.
    TIMESTAMP
    This item is a timestamp.
    UNRECOGNIZED
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FLAGS_VALUE
    Store this object as a special flags-style mapping.
    static final int
    ID_VALUE
    This is an ID field that should be used as the final name of this document.
    static final int
    KEY_VALUE
    This is a key field (a primary key sub-message) for a GROUP or COLLECTION-mode message.
    static final int
    PARENT_VALUE
    This field represents a key for this item's parent.
    static final int
    PATH_VALUE
    This field represents a full key path in hierarchical storage.
    static final int
    REFERENCE_VALUE
    This key is a foreign reference.
    static final int
    STANDARD_VALUE
    This is a standard field (default value).
    static final int
    TAGS_VALUE
    This is a tags-style field.
    static final int
    TIMESTAMP_VALUE
    This item is a timestamp.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FieldType
    forNumber(int value)
     
    static final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptor()
     
    final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptorForType()
     
    final int
    getNumber()
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
    getValueDescriptor()
     
    static com.google.protobuf.Internal.EnumLiteMap<FieldType>
    internalGetValueMap()
     
    static FieldType
    valueOf(int value)
    Deprecated.
    static FieldType
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this class with the specified name.
    static FieldType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static FieldType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • STANDARD

      public static final FieldType STANDARD
       This is a standard field (default value).
      STANDARD = 0;

    • KEY

      public static final FieldType KEY
       This is a key field (a primary key sub-message) for a GROUP or COLLECTION-mode message.
      KEY = 1;

    • ID

      public static final FieldType ID
       This is an ID field that should be used as the final name of this document.
      ID = 2;

    • TAGS

      public static final FieldType TAGS
       This is a tags-style field.
      TAGS = 3;

    • FLAGS

      public static final FieldType FLAGS
       Store this object as a special flags-style mapping.
      FLAGS = 4;

    • REFERENCE

      public static final FieldType REFERENCE
       This key is a foreign reference.
      REFERENCE = 5;

    • TIMESTAMP

      public static final FieldType TIMESTAMP
       This item is a timestamp.
      TIMESTAMP = 6;

    • PARENT

      public static final FieldType PARENT
       This field represents a key for this item's parent.
      PARENT = 7;

    • PATH

      public static final FieldType PATH
       This field represents a full key path in hierarchical storage.
      PATH = 8;

    • UNRECOGNIZED

      public static final FieldType UNRECOGNIZED

  • Field Details

    • STANDARD_VALUE

      public static final int STANDARD_VALUE
       This is a standard field (default value).
      STANDARD = 0;
      See Also:

    • KEY_VALUE

      public static final int KEY_VALUE
       This is a key field (a primary key sub-message) for a GROUP or COLLECTION-mode message.
      KEY = 1;
      See Also:

    • ID_VALUE

      public static final int ID_VALUE
       This is an ID field that should be used as the final name of this document.
      ID = 2;
      See Also:

    • TAGS_VALUE

      public static final int TAGS_VALUE
       This is a tags-style field.
      TAGS = 3;
      See Also:

    • FLAGS_VALUE

      public static final int FLAGS_VALUE
       Store this object as a special flags-style mapping.
      FLAGS = 4;
      See Also:

    • REFERENCE_VALUE

      public static final int REFERENCE_VALUE
       This key is a foreign reference.
      REFERENCE = 5;
      See Also:

    • TIMESTAMP_VALUE

      public static final int TIMESTAMP_VALUE
       This item is a timestamp.
      TIMESTAMP = 6;
      See Also:

    • PARENT_VALUE

      public static final int PARENT_VALUE
       This field represents a key for this item's parent.
      PARENT = 7;
      See Also:

    • PATH_VALUE

      public static final int PATH_VALUE
       This field represents a full key path in hierarchical storage.
      PATH = 8;
      See Also:

  • Method Details

    • values

      public static FieldType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static FieldType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static FieldType valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static FieldType forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<FieldType> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static FieldType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null