Package org.yaml.snakeyaml.events
Class CollectionStartEvent
- java.lang.Object
-
- org.yaml.snakeyaml.events.Event
-
- org.yaml.snakeyaml.events.NodeEvent
-
- org.yaml.snakeyaml.events.CollectionStartEvent
-
- Direct Known Subclasses:
MappingStartEvent,SequenceStartEvent
public abstract class CollectionStartEvent extends NodeEvent
Base class for the start events of the collection nodes.
-
-
Constructor Summary
Constructors Constructor Description CollectionStartEvent(String anchor, String tag, boolean implicit, Mark startMark, Mark endMark, DumperOptions.FlowStyle flowStyle)Create
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StringgetArguments()Generate human readable representation of the EventDumperOptions.FlowStylegetFlowStyle()trueif this collection is in flow style,falsefor block style.booleangetImplicit()trueif the tag can be omitted while this collection is emitted.StringgetTag()Tag of this collection.booleanisFlow()Getter-
Methods inherited from class org.yaml.snakeyaml.events.Event
equals, getEndMark, getEventId, getStartMark, hashCode, is, toString
-
-
-
-
Constructor Detail
-
CollectionStartEvent
public CollectionStartEvent(String anchor, String tag, boolean implicit, Mark startMark, Mark endMark, DumperOptions.FlowStyle flowStyle)
Create- Parameters:
anchor- - its anchortag- - its tagimplicit- - thue when the tag is implicitly resolvedstartMark- - startendMark- - endflowStyle- - style
-
-
Method Detail
-
getTag
public String getTag()
Tag of this collection.- Returns:
- The tag of this collection, or
nullif no explicit tag is available.
-
getImplicit
public boolean getImplicit()
trueif the tag can be omitted while this collection is emitted.- Returns:
- True if the tag can be omitted while this collection is emitted.
-
getFlowStyle
public DumperOptions.FlowStyle getFlowStyle()
trueif this collection is in flow style,falsefor block style.- Returns:
- If this collection is in flow style.
-
getArguments
protected String getArguments()
Description copied from class:EventGenerate human readable representation of the Event- Overrides:
getArgumentsin classNodeEvent- Returns:
- representation fore humans
- See Also:
- "__repr__ for Event in PyYAML"
-
isFlow
public boolean isFlow()
Getter- Returns:
- true for FLOW (exclude BLOCK and AUTO)
-
-