org.snakeyaml.engine.v2.events.CollectionStartEvent 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.common.Anchor;
import org.snakeyaml.engine.v2.common.FlowStyle;
import org.snakeyaml.engine.v2.exceptions.Mark;

/**
 * Base class for the start events of the collection nodes.
 */
public abstract class CollectionStartEvent extends NodeEvent {

  private final Optional tag;
  // The implicit flag of a collection start event indicates if the tag may be
  // omitted when the collection is emitted
  private final boolean implicit;
  // flag indicates if a collection is block or flow
  private final FlowStyle flowStyle;

  public CollectionStartEvent(Optional anchor, Optional tag, boolean implicit,
      FlowStyle flowStyle, Optional startMark, Optional endMark) {
    super(anchor, startMark, endMark);
    Objects.requireNonNull(tag);
    this.tag = tag;
    this.implicit = implicit;
    Objects.requireNonNull(flowStyle);
    this.flowStyle = flowStyle;
  }

  /**
   * Tag of this collection.
   *
   * @return The tag of this collection, or empty if no explicit tag is available.
   */
  public Optional getTag() {
    return this.tag;
  }

  /**
   * true if the tag can be omitted while this collection is emitted.
   *
   * @return True if the tag can be omitted while this collection is emitted.
   */
  public boolean isImplicit() {
    return this.implicit;
  }

  /**
   * true if this collection is in flow style, false for block style.
   *
   * @return If this collection is in flow style.
   */
  public FlowStyle getFlowStyle() {
    return this.flowStyle;
  }

  public boolean isFlow() {
    return FlowStyle.FLOW == flowStyle;
  }

  @Override
  public String toString() {
    StringBuilder builder = new StringBuilder();
    getAnchor().ifPresent(a -> builder.append(" &" + a));
    if (!implicit) {
      getTag().ifPresent(theTag -> builder.append(" <" + theTag + ">"));
    }
    return builder.toString();
  }
}