Package org.yaml.snakeyaml.events
Class DocumentStartEvent
- java.lang.Object
-
- org.yaml.snakeyaml.events.Event
-
- org.yaml.snakeyaml.events.DocumentStartEvent
-
public final class DocumentStartEvent extends Event
Marks the beginning of a document.This event followed by the document's content and a
DocumentEndEvent
.
-
-
Constructor Summary
Constructors Constructor Description DocumentStartEvent(Mark startMark, Mark endMark, boolean explicit, DumperOptions.Version version, Map<String,String> tags)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
getExplicit()
Map<String,String>
getTags()
Tag shorthands as defined by the%TAG
directive.DumperOptions.Version
getVersion()
YAML version the document conforms to.boolean
is(Event.ID id)
-
Methods inherited from class org.yaml.snakeyaml.events.Event
equals, getArguments, getEndMark, getStartMark, hashCode, toString
-
-
-
-
Method Detail
-
getExplicit
public boolean getExplicit()
-
getVersion
public DumperOptions.Version getVersion()
YAML version the document conforms to.- Returns:
null
if the document has no explicit%YAML
directive. Otherwise an array with two components, the major and minor part of the version (in this order).
-
getTags
public Map<String,String> getTags()
Tag shorthands as defined by the%TAG
directive.- Returns:
- Mapping of 'handles' to 'prefixes' (the handles include the '!' characters).
-
-