org.snakeyaml.engine.v2.events.StreamEndEvent 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.Optional;
import org.snakeyaml.engine.v2.exceptions.Mark;

/**
 * Marks the end of a stream that might have contained multiple documents.
 * 
 * This event is the last event that a parser emits. Together with {@link StreamStartEvent} (which
 * is the first event a parser emits) they mark the beginning and the end of a stream of documents.
 * 
 * 
 * See {@link Event} for an exemplary output.
 * 
 */
public final class StreamEndEvent extends Event {

  public StreamEndEvent(Optional startMark, Optional endMark) {
    super(startMark, endMark);
  }

  public StreamEndEvent() {
    super();
  }

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

  @Override
  public String toString() {
    return "-STR";
  }
}