SnakeYAML 2.2 · org.yaml.snakeyaml.parser.Parser

This interface represents an input stream of Events.

The parser and the scanner form together the 'Parse' step in the loading process (see chapter 3.1 of the YAML Specification).

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the next event can be assigned to a variable of the given type. Returns `false` if no more events are available. checkEvent(Event.ID Event ID. choice) Check if the next event is one of the given type.
public Event	Returns: the next parsed event getEvent() Returns the next event.
public Event	Returns: The event that will be returned on the next call to `getEvent` peekEvent() Return the next event, but do not delete it from the stream.

checkEvent back to summary

checkEvent	back to summary
public boolean checkEvent(Event.ID choice) Check if the next event is one of the given type. Parameters choice:Event.ID Event ID. Returns:boolean `true` if the next event can be assigned to a variable of the given type. Returns `false` if no more events are available. Exceptions ParserException: Thrown in case of malformed input.

public boolean checkEvent(Event.ID choice)

Check if the next event is one of the given type.

Parameters

Returns:boolean

true if the next event can be assigned to a variable of the given type. Returns false if no more events are available.

Exceptions

getEvent	back to summary
public Event getEvent() Returns the next event. The event will be removed from the stream. Returns:Event the next parsed event Exceptions ParserException: Thrown in case of malformed input.

getEvent

public Event getEvent()

Returns the next event.

The event will be removed from the stream.

Returns:Event

the next parsed event

Exceptions

peekEvent back to summary

peekEvent	back to summary
public Event peekEvent() Return the next event, but do not delete it from the stream. Returns:Event The event that will be returned on the next call to `getEvent` Exceptions ParserException: Thrown in case of malformed input.

public Event peekEvent()

Return the next event, but do not delete it from the stream.

Returns:Event

The event that will be returned on the next call to getEvent

Exceptions