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

Go to download
/*
 * 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.Optional;
import org.snakeyaml.engine.v2.common.Anchor;
import org.snakeyaml.engine.v2.common.FlowStyle;
import org.snakeyaml.engine.v2.exceptions.Mark;

/**
 * Marks the beginning of a sequence node.
 * 
 * This event is followed by the elements contained in the sequence, and a {@link
 * SequenceEndEvent}.
 * 
 *
 * @see SequenceEndEvent
 */
public final class SequenceStartEvent extends CollectionStartEvent {

  public SequenceStartEvent(Optional anchor, Optional tag, boolean implicit,
      FlowStyle flowStyle, Optional startMark,
      Optional endMark) {
    super(anchor, tag, implicit, flowStyle, startMark, endMark);
  }

  public SequenceStartEvent(Optional anchor, Optional tag, boolean implicit,
      FlowStyle flowStyle) {
    this(anchor, tag, implicit, flowStyle, Optional.empty(), Optional.empty());
  }

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

  @Override
  public String toString() {
    StringBuilder builder = new StringBuilder("+SEQ");
    if (getFlowStyle() == FlowStyle.FLOW) {
      builder.append(" []");
    }
    builder.append(super.toString());
    return builder.toString();
  }
}