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.
  • Nested Class Summary

    Nested classes/interfaces inherited from class org.yaml.snakeyaml.events.Event

    Event.ID
  • Constructor Summary

    Constructors 
    Constructor Description
    CollectionStartEvent​(java.lang.String anchor, java.lang.String tag, boolean implicit, Mark startMark, Mark endMark, java.lang.Boolean flowStyle)
    Deprecated.
    CollectionStartEvent​(java.lang.String anchor, java.lang.String tag, boolean implicit, Mark startMark, Mark endMark, DumperOptions.FlowStyle flowStyle)  
  • Method Summary

    Modifier and Type Method Description
    protected java.lang.String getArguments()
    Generate human readable representation of the Event
    DumperOptions.FlowStyle getFlowStyle()
    true if this collection is in flow style, false for block style.
    boolean getImplicit()
    true if the tag can be omitted while this collection is emitted.
    java.lang.String getTag()
    Tag of this collection.
    boolean isFlow()  

    Methods inherited from class org.yaml.snakeyaml.events.NodeEvent

    getAnchor

    Methods inherited from class org.yaml.snakeyaml.events.Event

    equals, getEndMark, getEventId, getStartMark, hashCode, is, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • CollectionStartEvent

      public CollectionStartEvent​(java.lang.String anchor, java.lang.String tag, boolean implicit, Mark startMark, Mark endMark, DumperOptions.FlowStyle flowStyle)
    • CollectionStartEvent

      @Deprecated public CollectionStartEvent​(java.lang.String anchor, java.lang.String tag, boolean implicit, Mark startMark, Mark endMark, java.lang.Boolean flowStyle)
      Deprecated.
  • Method Details

    • getTag

      public java.lang.String getTag()
      Tag of this collection.
      Returns:
      The tag of this collection, or null if no explicit tag is available.
    • getImplicit

      public boolean getImplicit()
      true if 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()
      true if this collection is in flow style, false for block style.
      Returns:
      If this collection is in flow style.
    • getArguments

      protected java.lang.String getArguments()
      Description copied from class: Event
      Generate human readable representation of the Event
      Overrides:
      getArguments in class NodeEvent
      Returns:
      representation fore humans
      See Also:
      "__repr__ for Event in PyYAML"
    • isFlow

      public boolean isFlow()