org.yaml.snakeyaml.nodes.CollectionNode Maven / Gradle / Ivy

Go to download

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

YAML 1.1 parser and emitter for Java

There is a newer version: 2.3

/**
 * Copyright (c) 2008, 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.yaml.snakeyaml.nodes;

import java.util.List;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.error.Mark;

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

  private DumperOptions.FlowStyle flowStyle;

  /**
   * Create
   *
   * @param tag - its tag
   * @param startMark - start
   * @param endMark - end
   * @param flowStyle - style
   */
  public CollectionNode(Tag tag, Mark startMark, Mark endMark, DumperOptions.FlowStyle flowStyle) {
    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 DumperOptions.FlowStyle getFlowStyle() {
    return flowStyle;
  }

  /**
   * Setter
   *
   * @param flowStyle - flow style for collections
   */
  public void setFlowStyle(DumperOptions.FlowStyle flowStyle) {
    if (flowStyle == null) {
      throw new NullPointerException("Flow style must be provided.");
    }
    this.flowStyle = flowStyle;
  }

  /**
   * Setter
   *
   * @param endMark - end
   */
  public void setEndMark(Mark endMark) {
    this.endMark = endMark;
  }
}