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  *
  12  * Contains the methods for getting the data which are part of the YANG
  13  * <code>extensoion</code> statement.
  14  *
  15  */
  16 public interface ExtensionDefinition extends SchemaNode {
  17
  18     /**
  19      * Returns the <code>String</code> that is the name of argument to the
  20      * Keyword. If no argument statement is present the method will return
  21      * <code>null</code> <br>
  22      * The argument statement is defined in <a
  23      * href="https://tools.ietf.org/html/rfc6020#section-7.17.2">[RFC-6020] The
  24      * argument Statement</a>
  25      *
  26      * @return the <code>String</code> that is the name of argument to the
  27      *         Keyword. If no argument statement is present the method will
  28      *         return <code>null</code>
  29      */
  30     String getArgument();
  31
  32     /**
  33      * This statement indicates if the argument is mapped to an XML element in
  34      * YIN or to an XML attribute.<br>
  35      * By contract if implementation of ExtensionDefinition does not specify the
  36      * yin-element statement the return value is by default set to
  37      * <code>false</code>
  38      *
  39      * <br>
  40      * <br>
  41      * For more specific definition please look into <a
  42      * href="https://tools.ietf.org/html/rfc6020#section-7.17.2.2">[RFC-6020]
  43      * The yin-element Statement</a>
  44      *
  45      * @return <code>true</code> if the argument is mapped to an XML element in
  46      *         YIN or returns <code>false</code> if the argument is mapped to an
  47      *         XML attribute.
  48      */
  49     boolean isYinElement();
  50 }