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 beginning of a mapping node.
     22  * <p>
     23  * This event is followed by a number of key value pairs. <br>
     24  * The pairs are not in any particular order. However, the value always directly
     25  * follows the corresponding key. <br>
     26  * After the key value pairs follows a {@link MappingEndEvent}.
     27  * </p>
     28  * <p>
     29  * There must be an even number of node events between the start and end event.
     30  * </p>
     31  *
     32  * @see MappingEndEvent
     33  */
     34 public final class MappingStartEvent extends CollectionStartEvent {
     35     public MappingStartEvent(String anchor, String tag, boolean implicit, Mark startMark,
     36             Mark endMark, Boolean flowStyle) {
     37         super(anchor, tag, implicit, startMark, endMark, flowStyle);
     38     }
     39 
     40     @Override
     41     public boolean is(Event.ID id) {
     42         return ID.MappingStart == id;
     43     }
     44 }
     45