Enum Class LayerKind

java.lang.Object
java.lang.Enum<LayerKind>
dev.hardwood.reader.LayerKind
All Implemented Interfaces:
Serializable, Comparable<LayerKind>, Constable

@Experimental public enum LayerKind extends Enum<LayerKind>

Classifies a ColumnReader layer between root and leaf.

A layer is contributed by a user-authored OPTIONAL group (STRUCT) or by a LIST/MAP-annotated group (REPEATED). REQUIRED groups and the synthetic scaffolding inside a LIST/MAP (the inner repeated group) do not contribute layers.

Stable for the lifetime of the ColumnReader and safe to cache once at open time.

  • Enum Constant Details

    • STRUCT

      public static final LayerKind STRUCT
      A user-authored OPTIONAL group along the schema chain. Contributes a validity bitmap (getLayerValidity) but no offsets.
    • REPEATED

      public static final LayerKind REPEATED
      A LIST or MAP-annotated group. Contributes both a validity bitmap (for the list-itself-null distinction) and an offsets buffer (getLayerOffsets) that walks into the next inner layer's items.
  • Method Details

    • values

      public static LayerKind[] 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 LayerKind 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