Class StreamStartEvent


  • public final class StreamStartEvent
    extends Event
    Marks the start of a stream that might contain multiple documents.

    This event is the first event that a parser emits. Together with StreamEndEvent (which is the last event a parser emits) they mark the beginning and the end of a stream of documents.

    See Event for an exemplary output.

    • Constructor Detail

      • StreamStartEvent

        public StreamStartEvent​(java.util.Optional<Mark> startMark,
                                java.util.Optional<Mark> endMark)
      • StreamStartEvent

        public StreamStartEvent()
    • Method Detail

      • getEventId

        public Event.ID getEventId()
        Description copied from class: Event
        Get the type (kind) if this Event
        Specified by:
        getEventId in class Event
        Returns:
        the ID of this Event
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object