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