Module io.xlate.staedi
Package io.xlate.edi.stream

Enum EDIStreamEvent

java.lang.Object
java.lang.Enum<EDIStreamEvent>
io.xlate.edi.stream.EDIStreamEvent
All Implemented Interfaces:
Serializable, Comparable<EDIStreamEvent>
public enum EDIStreamEvent extends Enum<EDIStreamEvent>
Enumeration of stream event types that may be encountered by the EDIStreamReader.
See Also:

  • Enum Constant Details

    • ELEMENT_DATA

      public static final EDIStreamEvent ELEMENT_DATA
      Event for a simple element or component element (within a composite).

    • ELEMENT_DATA_BINARY

      public static final EDIStreamEvent ELEMENT_DATA_BINARY
      Event for binary element data
      See Also:

    • START_COMPOSITE

      public static final EDIStreamEvent START_COMPOSITE
      Event for the start of a composite element.

    • END_COMPOSITE

      public static final EDIStreamEvent END_COMPOSITE
      Event for the end of a composite element.

    • START_SEGMENT

      public static final EDIStreamEvent START_SEGMENT
      Event for the start of a segment.

    • END_SEGMENT

      public static final EDIStreamEvent END_SEGMENT
      Event for the end of a segment.

    • START_INTERCHANGE

      public static final EDIStreamEvent START_INTERCHANGE
      Event for the start of an interchange.

    • END_INTERCHANGE

      public static final EDIStreamEvent END_INTERCHANGE
      Event for the end of an interchange.

    • START_GROUP

      public static final EDIStreamEvent START_GROUP
      Event for the start of a functional group.

    • END_GROUP

      public static final EDIStreamEvent END_GROUP
      Event for the end of a functional group.

    • START_TRANSACTION

      public static final EDIStreamEvent START_TRANSACTION
      Event for the start of a transaction.

    • END_TRANSACTION

      public static final EDIStreamEvent END_TRANSACTION
      Event for the end of a transaction.

    • START_LOOP

      public static final EDIStreamEvent START_LOOP
      Event for the start of a data loop (logical grouping of segments).

    • END_LOOP

      public static final EDIStreamEvent END_LOOP
      Event for the end of a data loop (logical grouping of segments).

    • SEGMENT_ERROR

      public static final EDIStreamEvent SEGMENT_ERROR
      Event for an error relating to a segment

    • ELEMENT_DATA_ERROR

      public static final EDIStreamEvent ELEMENT_DATA_ERROR
      Event for an error relating to the data received in an element.

    • ELEMENT_OCCURRENCE_ERROR

      public static final EDIStreamEvent ELEMENT_OCCURRENCE_ERROR
      Event for an error relating to the an occurrence of an element. E.g. a missing required element.

  • Method Details

    • values

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

    • valueOf

      public static EDIStreamEvent valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • isError

      public boolean isError()
      Indicates whether a particular EDIStreamEvent represents a validation error.
      Returns:
      true when the event represents a validation error, otherwise false.