Package org.snakeyaml.engine.v2.parser
Interface Parser
-
- All Superinterfaces:
Iterator<org.snakeyaml.engine.v2.events.Event>
- All Known Implementing Classes:
ParserImpl
public interface Parser extends Iterator<org.snakeyaml.engine.v2.events.Event>
This interface represents an input stream ofEvents.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 booleancheckEvent(org.snakeyaml.engine.v2.events.Event.ID choice)Check if the next event is one of the given type.org.snakeyaml.engine.v2.events.Eventnext()Returns the next event.org.snakeyaml.engine.v2.events.EventpeekEvent()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(org.snakeyaml.engine.v2.events.Event.ID choice)
Check if the next event is one of the given type.- Parameters:
choice- Event ID to match- Returns:
trueif the next event has the given ID. Returnsfalseif no more events are available.- Throws:
ParserException- Thrown in case of malformed input.
-
peekEvent
org.snakeyaml.engine.v2.events.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
org.snakeyaml.engine.v2.events.Event next()
Returns the next event.The event will be removed from the stream.
- Specified by:
nextin interfaceIterator<org.snakeyaml.engine.v2.events.Event>- Returns:
- the next parsed event
- Throws:
ParserException- Thrown in case of malformed input.
-
-