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   * Base class for all events that mark the beginning of a node.
23   */
24  public abstract class NodeEvent extends Event {
25  
26      private final String anchor;
27  
28      public NodeEvent(String anchor, Mark startMark, Mark endMark) {
29          super(startMark, endMark);
30          this.anchor = anchor;
31      }
32  
33      /**
34       * Node anchor by which this node might later be referenced by a
35       * {@link AliasEvent}.
36       * <p>
37       * Note that {@link AliasEvent}s are by it self <code>NodeEvent</code>s and
38       * use this property to indicate the referenced anchor.
39       * 
40       * @return Anchor of this node or <code>null</code> if no anchor is defined.
41       */
42      public String getAnchor() {
43          return this.anchor;
44      }
45  
46      @Override
47      protected String getArguments() {
48          return "anchor=" + anchor;
49      }
50  }