View Javadoc

1   /**
2    * Copyright (c) 2008-2012, 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.representer;
17  
18  import org.yaml.snakeyaml.nodes.Node;
19  
20  /**
21   * Create a Node Graph out of the provided Native Data Structure (Java
22   * instance).
23   * 
24   * @see <a href="http://yaml.org/spec/1.1/#id859109">Chapter 3. Processing YAML
25   *      Information</a>
26   */
27  public interface Represent {
28      /**
29       * Create a Node
30       * 
31       * @param data
32       *            the instance to represent
33       * @return Node to dump
34       */
35      public Node representData(Object data);
36  }