yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ExtensionDefinition.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.api;
   9
  10 /**
  11  * Contains the methods for getting the data which are part of the YANG
  12  * <code>extensoion</code> statement.
  13  */
  14 public interface ExtensionDefinition extends SchemaNode {
  15     /**
  16      * Returns the <code>String</code> that is the name of argument to the
  17      * Keyword. If no argument statement is present the method will return
  18      * <code>null</code> <br>
  19      * The argument statement is defined in <a
  20      * href="https://tools.ietf.org/html/rfc6020#section-7.17.2">[RFC-6020] The
  21      * argument Statement</a>
  22      *
  23      * @return the <code>String</code> that is the name of argument to the
  24      *         Keyword. If no argument statement is present the method will
  25      *         return <code>null</code>
  26      */
  27     String getArgument();
  28
  29     /**
  30      * This statement indicates if the argument is mapped to an XML element in
  31      * YIN or to an XML attribute.<br>
  32      * By contract if implementation of ExtensionDefinition does not specify the
  33      * yin-element statement the return value is by default set to
  34      * <code>false</code>
  35      *
  36      * <p>
  37      * For more specific definition please look into <a
  38      * href="https://tools.ietf.org/html/rfc6020#section-7.17.2.2">[RFC-6020]
  39      * The yin-element Statement</a>
  40      *
  41      * @return <code>true</code> if the argument is mapped to an XML element in
  42      *         YIN or returns <code>false</code> if the argument is mapped to an
  43      *         XML attribute.
  44      */
  45     boolean isYinElement();
  46 }