org.opendaylight.yangtools.yang.model.export

Class YinExportUtils

java.lang.Object

org.opendaylight.yangtools.yang.model.export.YinExportUtils

public final class YinExportUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static String	wellFormedYinName(String name, Optional<Revision> revision) Returns well-formed file name of YIN file as defined in RFC6020.
static String	wellFormedYinName(String name, String revision) Returns well-formed file name of YIN file as defined in RFC6020.
static void	writeModuleAsYinText(Module module, OutputStream output) Write a module as a YIN text into specified OutputStream.
static void	writeSubmoduleAsYinText(Module parentModule, Module submodule, OutputStream output) Write a submodule as a YIN text into specified OutputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

wellFormedYinName

public static String wellFormedYinName(String name,
                                       Optional<Revision> revision)

Returns well-formed file name of YIN file as defined in RFC6020.

Parameters:

name - Module or submodule name

revision - Revision of module or submodule

Returns:

well-formed file name of YIN file as defined in RFC6020.

wellFormedYinName

public static String wellFormedYinName(String name,
                                       String revision)

Returns well-formed file name of YIN file as defined in RFC6020.

Parameters:

name - name Module or submodule name

revision - Revision of module or submodule

Returns:

well-formed file name of YIN file as defined in RFC6020.

writeModuleAsYinText

@Beta
public static void writeModuleAsYinText(Module module,
                                              OutputStream output)
                                       throws XMLStreamException

Write a module as a YIN text into specified OutputStream. Supplied module must have the ModuleEffectiveStatement trait.

Parameters:

module - Module to be exported

Throws:

IllegalArgumentException - if the module is not an ModuleEffectiveStatement or if it declared representation is not available.

NullPointerException - if any of of the parameters is null

XMLStreamException - if an input-output error occurs

writeSubmoduleAsYinText

@Beta
public static void writeSubmoduleAsYinText(Module parentModule,
                                                 Module submodule,
                                                 OutputStream output)
                                          throws XMLStreamException

Write a submodule as a YIN text into specified OutputStream. Supplied submodule must have the SubmoduleEffectiveStatement trait.

Parameters:

parentModule - Parent module

submodule - Submodule to be exported

Throws:

IllegalArgumentException - if the parent module is not a ModuleEffectiveStatement, if the submodule is not a SubmoduleEffectiveStatement or if its declared representation is not available

NullPointerException - if any of of the parameters is null

XMLStreamException - if an input-output error occurs