org.onosproject.yang.compiler.translator.tojava

Class YangJavaModelUtils

java.lang.Object

org.onosproject.yang.compiler.translator.tojava.YangJavaModelUtils

public final class YangJavaModelUtils
extends Object

Represents utility class for YANG java model.

Method Summary

Modifier and Type	Method and Description
static void	generateCodeAndUpdateInParent(JavaCodeGeneratorInfo info, org.onosproject.yang.compiler.utils.io.YangPluginConfig config, boolean isMultiInstance) Generates code for the current ata model node and adds itself as an attribute in the parent.
static void	generateCodeOfAugmentableNode(JavaCodeGeneratorInfo info, org.onosproject.yang.compiler.utils.io.YangPluginConfig config) Generates code for the current data model node and adds support for it to be augmented.
static void	generateCodeOfNode(JavaCodeGeneratorInfo info, org.onosproject.yang.compiler.utils.io.YangPluginConfig config) Generates code for the current data model node.
static void	generateCodeOfRootNode(JavaCodeGeneratorInfo info, org.onosproject.yang.compiler.utils.io.YangPluginConfig config, String rootPkg) Generates code for the root module/sub-module node.
static void	generateInterfaceFileForNonDataNodes(org.onosproject.yang.compiler.datamodel.YangNode rootNode) Generates interface file for those yang file which contains only any of these grouping, typedef and identity.
static void	generateJava(int type, org.onosproject.yang.compiler.datamodel.YangNode node) Generated java code during exit.
static String	getAugmentClassName(org.onosproject.yang.compiler.datamodel.YangAugment augment, org.onosproject.yang.compiler.utils.io.YangPluginConfig config) Returns augment class name.
static String	getCurNodePackage(org.onosproject.yang.compiler.datamodel.YangNode curNode) Returns the node package string.
static String	getNodesPackage(org.onosproject.yang.compiler.datamodel.YangNode node, org.onosproject.yang.compiler.utils.io.YangPluginConfig config) Returns nodes package.
static boolean	isRootNodesCodeGenRequired(org.onosproject.yang.compiler.datamodel.YangNode node) Returns true if root node contains any data node.
static void	updatePackageInfo(JavaCodeGeneratorInfo info, org.onosproject.yang.compiler.utils.io.YangPluginConfig config) Updates YANG java file package information.

Methods inherited from class java.lang.Object

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

Method Detail

updatePackageInfo

public static void updatePackageInfo(JavaCodeGeneratorInfo info,
                                     org.onosproject.yang.compiler.utils.io.YangPluginConfig config)

Updates YANG java file package information.

Parameters:

info - YANG java file info node

config - YANG plugin config

generateCodeAndUpdateInParent

public static void generateCodeAndUpdateInParent(JavaCodeGeneratorInfo info,
                                                 org.onosproject.yang.compiler.utils.io.YangPluginConfig config,
                                                 boolean isMultiInstance)
                                          throws IOException

Generates code for the current ata model node and adds itself as an attribute in the parent.

Parameters:

info - YANG java file info node

config - YANG plugin config

isMultiInstance - flag to indicate whether it's a list

Throws:

IOException - IO operations fails

generateCodeOfAugmentableNode

public static void generateCodeOfAugmentableNode(JavaCodeGeneratorInfo info,
                                                 org.onosproject.yang.compiler.utils.io.YangPluginConfig config)
                                          throws IOException

Generates code for the current data model node and adds support for it to be augmented.

Parameters:

info - YANG java file info node

config - YANG plugin config

Throws:

IOException - IO operations fails

generateCodeOfNode

public static void generateCodeOfNode(JavaCodeGeneratorInfo info,
                                      org.onosproject.yang.compiler.utils.io.YangPluginConfig config)
                               throws IOException

Generates code for the current data model node.

Parameters:

info - YANG java file info node

config - YANG plugin config

Throws:

IOException - IO operations fails

generateCodeOfRootNode

public static void generateCodeOfRootNode(JavaCodeGeneratorInfo info,
                                          org.onosproject.yang.compiler.utils.io.YangPluginConfig config,
                                          String rootPkg)
                                   throws IOException

Generates code for the root module/sub-module node.

Parameters:

info - YANG java file info node

config - YANG plugin config

rootPkg - package of the root node

Throws:

IOException - IO operations fails

getCurNodePackage

public static String getCurNodePackage(org.onosproject.yang.compiler.datamodel.YangNode curNode)
                                throws TranslatorException

Returns the node package string.

Parameters:

curNode - current java node whose package string needs to be set

Returns:

returns the root package string

Throws:

TranslatorException - on error

isRootNodesCodeGenRequired

public static boolean isRootNodesCodeGenRequired(org.onosproject.yang.compiler.datamodel.YangNode node)

Returns true if root node contains any data node.

Parameters:

node - root YANG node

Returns:

true if root node contains any data node

getNodesPackage

public static String getNodesPackage(org.onosproject.yang.compiler.datamodel.YangNode node,
                                     org.onosproject.yang.compiler.utils.io.YangPluginConfig config)

Returns nodes package.

Parameters:

node - YANG node

config - plugin config

Returns:

java package

getAugmentClassName

public static String getAugmentClassName(org.onosproject.yang.compiler.datamodel.YangAugment augment,
                                         org.onosproject.yang.compiler.utils.io.YangPluginConfig config)

Returns augment class name.

Parameters:

augment - YANG augment

config - plugin configurations

Returns:

augment class name

generateJava

public static void generateJava(int type,
                                org.onosproject.yang.compiler.datamodel.YangNode node)
                         throws IOException

Generated java code during exit.

Parameters:

type - generated file type

node - current YANG node

Throws:

IOException - when fails to generate java files

generateInterfaceFileForNonDataNodes

public static void generateInterfaceFileForNonDataNodes(org.onosproject.yang.compiler.datamodel.YangNode rootNode)
                                                 throws IOException

Generates interface file for those yang file which contains only any of these grouping, typedef and identity.

Parameters:

rootNode - root node

Throws:

IOException - when fails to do IO operations