org.snakeyaml.engine.v2.events.CommentEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of snakeyaml-engine Show documentation

Core YAML 1.2 parser and emitter for Java

The newest version!

/*
 * Copyright (c) 2018, SnakeYAML
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package org.snakeyaml.engine.v2.events;

import java.util.Objects;
import java.util.Optional;
import org.snakeyaml.engine.v2.comments.CommentType;
import org.snakeyaml.engine.v2.exceptions.Mark;

/**
 * Marks a comment block value.
 */
public final class CommentEvent extends Event {

  private final CommentType type;
  private final String value;

  public CommentEvent(CommentType type, String value, Optional startMark,
      Optional endMark) {
    super(startMark, endMark);
    Objects.requireNonNull(type);
    this.type = type;
    Objects.requireNonNull(value);
    this.value = value;
  }

  /**
   * String representation of the value.
   * 
   * Without quotes and escaping.
   * 
   *
   * @return Value a comment line string without the leading '#' or a blank line.
   */
  public String getValue() {
    return this.value;
  }

  /**
   * The comment type.
   *
   * @return the commentType.
   */
  public CommentType getCommentType() {
    return this.type;
  }

  @Override
  public Event.ID getEventId() {
    return ID.Comment;
  }

  @Override
  public String toString() {
    String builder = "=COM " + type + " " + value;
    return builder;
  }
}