Home | History | Annotate | Download | only in events
      1 /**
      2  * Copyright (c) 2008, 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 package org.yaml.snakeyaml.events;
     17 
     18 import org.yaml.snakeyaml.error.Mark;
     19 
     20 /**
     21  * Marks the start of a stream that might contain multiple documents.
     22  * <p>
     23  * This event is the first event that a parser emits. Together with
     24  * {@link StreamEndEvent} (which is the last event a parser emits) they mark the
     25  * beginning and the end of a stream of documents.
     26  * </p>
     27  * <p>
     28  * See {@link Event} for an exemplary output.
     29  * </p>
     30  */
     31 public final class StreamStartEvent extends Event {
     32 
     33     public StreamStartEvent(Mark startMark, Mark endMark) {
     34         super(startMark, endMark);
     35     }
     36 
     37     @Override
     38     public boolean is(Event.ID id) {
     39         return ID.StreamStart == id;
     40     }
     41 }
     42