Interface Parser

  • All Superinterfaces:
    java.util.Iterator<Event>
    All Known Implementing Classes:
    ParserImpl

    public interface Parser
    extends java.util.Iterator<Event>
    This interface represents an input stream of Events.

    The parser and the scanner form together the 'Parse' step in the loading process.

    See Also:
    Figure 3.1. Processing Overview
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean checkEvent​(Event.ID choice)
      Check if the next event is one of the given type.
      Event next()
      Returns the next event.
      Event peekEvent()
      Return the next event, but do not delete it from the stream.
      • Methods inherited from interface java.util.Iterator

        forEachRemaining, hasNext, remove
    • Method Detail

      • checkEvent

        boolean checkEvent​(Event.ID choice)
        Check if the next event is one of the given type.
        Parameters:
        choice - Event ID to match
        Returns:
        true if the next event has the given ID. Returns false if no more events are available.
        Throws:
        ParserException - Thrown in case of malformed input.
      • peekEvent

        Event peekEvent()
        Return the next event, but do not delete it from the stream.
        Returns:
        The event that will be returned on the next call to next()
        Throws:
        ParserException - Thrown in case of malformed input or NoSuchElementException in case no event is available.
      • next

        Event next()
        Returns the next event.

        The event will be removed from the stream.

        Specified by:
        next in interface java.util.Iterator<Event>
        Returns:
        the next parsed event
        Throws:
        ParserException - Thrown in case of malformed input.