org.opendaylight.yangtools.yang.model.api.ExtensionDefinition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yangtools-docs Show documentation

YANG Tools documentation

There is a newer version: 14.0.4

/*
 * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.yang.model.api;

import org.opendaylight.yangtools.yang.model.api.stmt.ExtensionEffectiveStatement;

/**
 * Contains the methods for getting the data which are part of the YANG {@code extensoion} statement.
 */
public interface ExtensionDefinition extends SchemaNode, EffectiveStatementEquivalent {
    /**
     * Returns the String that is the name of argument to the
     * Keyword. If no argument statement is present the method will return
     * null 

     * The argument statement is defined in [RFC-6020] The
     * argument Statement
     *
     * @return the String that is the name of argument to the
     *         Keyword. If no argument statement is present the method will
     *         return null
     */
    String getArgument();

    /**
     * This statement indicates if the argument is mapped to an XML element in
     * YIN or to an XML attribute.

     * By contract if implementation of ExtensionDefinition does not specify the
     * yin-element statement the return value is by default set to
     * false
     *
     * 
     * For more specific definition please look into [RFC-6020]
     * The yin-element Statement
     *
     * @return true if the argument is mapped to an XML element in
     *         YIN or returns false if the argument is mapped to an
     *         XML attribute.
     */
    boolean isYinElement();
}