opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ExtensionDefinition.java

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