StructType (Apache Geode 2.0.2)
Description: declaration: package: org.apache.geode.cache.query.types, interface: StructType

Package org.apache.geode.cache.query.types

# Interface StructType

All Superinterfaces:
  `DataSerializable`, `ObjectType`, `Serializable`

public interface StructType extends ObjectType
Describes the field names and types for each field in a `Struct`.

Since:
  GemFire 4.0

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from interface org.apache.geode.DataSerializable

  `DataSerializable.Replaceable`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getFieldIndex(String fieldName)`
  Returns the index of the field with the given name in this `StructType`.
  `String[]`
  `getFieldNames()`
  Get the names of the fields for this struct
  `ObjectType[]`
  `getFieldTypes()`
  The the types of the fields for this struct

  ### Methods inherited from interface org.apache.geode.DataSerializable

  `fromData, toData`

  ### Methods inherited from interface org.apache.geode.cache.query.types.ObjectType

  `getSimpleClassName, isCollectionType, isMapType, isStructType, resolveClass`

- ## Method Details

  - ### getFieldTypes

    ObjectType[] getFieldTypes()
    The the types of the fields for this struct
    Returns:
      the array of Class for the fields

  - ### getFieldNames

    String[] getFieldNames()
    Get the names of the fields for this struct
    Returns:
      the array of field names

  - ### getFieldIndex

    int getFieldIndex(String fieldName)
    Returns the index of the field with the given name in this `StructType`.
    Parameters:
      `fieldName` - the name of the field
    Returns:
      the index of the field with the given name in this `StructType`
    Throws:
      `IllegalArgumentException` - If this `StructType` does not contain a field named `fieldName`.