org.snakeyaml.engine.v2.nodes.CollectionNode 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.nodes;

import java.util.List;
import java.util.Objects;
import java.util.Optional;
import org.snakeyaml.engine.v2.common.FlowStyle;
import org.snakeyaml.engine.v2.exceptions.Mark;

/**
 * Base class for the two collection types {@link MappingNode mapping} and {@link SequenceNode
 * collection}.
 */
public abstract class CollectionNode extends Node {

  private FlowStyle flowStyle;

  public CollectionNode(Tag tag, FlowStyle flowStyle, Optional startMark,
      Optional endMark) {
    super(tag, startMark, endMark);
    setFlowStyle(flowStyle);
  }

  /**
   * Returns the elements in this sequence.
   *
   * @return Nodes in the specified order.
   */
  public abstract List getValue();

  /**
   * Serialization style of this collection.
   *
   * @return true for flow style, false for block style.
   */
  public FlowStyle getFlowStyle() {
    return flowStyle;
  }

  public void setFlowStyle(FlowStyle flowStyle) {
    Objects.requireNonNull(flowStyle, "Flow style must be provided.");
    this.flowStyle = flowStyle;
  }

  public void setEndMark(Optional endMark) {
    this.endMark = endMark;
  }
}