View Javadoc

    1   /**
    2    * Copyright (c) 2008-2011, http://www.snakeyaml.org
    3    *
    4    * Licensed under the Apache License, Version 2.0 (the "License");
    5    * you may not use this file except in compliance with the License.
    6    * You may obtain a copy of the License at
    7    *
    8    *     http://www.apache.org/licenses/LICENSE-2.0
    9    *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16
    17  package org.yaml.snakeyaml.events;
    18
    19  import org.yaml.snakeyaml.error.Mark;
    20
    21  /**
    22   * Marks the end of a stream that might have contained multiple documents.
    23   * <p>
    24   * This event is the last event that a parser emits. Together with
    25   * {@link StreamStartEvent} (which is the first event a parser emits) they mark
    26   * the beginning and the end of a stream of documents.
    27   * </p>
    28   * <p>
    29   * See {@link Event} for an exemplary output.
    30   * </p>
    31   */
    32  public final class StreamEndEvent extends Event {
    33      public StreamEndEvent(Mark startMark, Mark endMark) {
    34          super(startMark, endMark);
    35      }
    36
    37      @Override
    38      public boolean is(Event.ID id) {
    39          return ID.StreamEnd == id;
    40      }
    41  }