Class CommentEvent


  • public final class CommentEvent
    extends Event
    Marks a comment block value.
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.snakeyaml.engine.v2.events.Event

        Event.ID
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private CommentType type  
      private java.lang.String value  
    • Constructor Summary

      Constructors 
      Constructor Description
      CommentEvent​(CommentType type, java.lang.String value, java.util.Optional<Mark> startMark, java.util.Optional<Mark> endMark)  
    • Field Detail

      • value

        private final java.lang.String value
    • Constructor Detail

      • CommentEvent

        public CommentEvent​(CommentType type,
                            java.lang.String value,
                            java.util.Optional<Mark> startMark,
                            java.util.Optional<Mark> endMark)
    • Method Detail

      • getValue

        public java.lang.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.
      • 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
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object