Class CommentEvent

java.lang.Object
org.yaml.snakeyaml.events.Event
org.yaml.snakeyaml.events.CommentEvent

public final class CommentEvent extends Event
Marks a comment block value.
  • Constructor Details

    • CommentEvent

      public CommentEvent(CommentType type, String value, Mark startMark, Mark endMark)
      Create
      Parameters:
      type - - kind
      value - - text
      startMark - - start
      endMark - - end
  • Method Details

    • getValue

      public String getValue()
      String representation of the value.

      Without quotes and escaping.

      Returns:
      Value a comment line string without the leading '#' or a blank line.
    • getCommentType

      public CommentType getCommentType()
      The comment type.
      Returns:
      the commentType.
    • getArguments

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

      public Event.ID getEventId()
      Description copied from class: Event
      Get the type (kind) if this Event
      Specified by:
      getEventId in class Event
      Returns:
      the ID of this Event