org.yaml.snakeyaml.events.NodeEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of snakeyaml Show documentation

YAML 1.1 parser and emitter for Java

There is a newer version: 2.3

/**
 * Copyright (c) 2008, 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.yaml.snakeyaml.events;

import org.yaml.snakeyaml.error.Mark;

/**
 * Base class for all events that mark the beginning of a node.
 */
public abstract class NodeEvent extends Event {

  private final String anchor;

  public NodeEvent(String anchor, Mark startMark, Mark endMark) {
    super(startMark, endMark);
    this.anchor = anchor;
  }

  /**
   * Node anchor by which this node might later be referenced by a {@link AliasEvent}.
   * 
   * Note that {@link AliasEvent}s are by it self NodeEvents and use this property to
   * indicate the referenced anchor.
   *
   * @return Anchor of this node or null if no anchor is defined.
   */
  public String getAnchor() {
    return this.anchor;
  }

  @Override
  protected String getArguments() {
    return "anchor=" + anchor;
  }
}