org.onosproject.yang.compiler.translator.tojava.utils

Class JavaFileGeneratorUtils

java.lang.Object

org.onosproject.yang.compiler.translator.tojava.utils.JavaFileGeneratorUtils

public final class JavaFileGeneratorUtils
extends Object

Represents utilities for java file generator.

Method Summary

Modifier and Type	Method and Description
static String	getAddToListMethodInterface(JavaAttributeInfo attr, String className) Returns add to list method interface.
static String	getCompareToForKeyClass(List<JavaAttributeInfo> attrs, String className) Returns compare to method for key class.
static String	getDerivedPackage(org.onosproject.yang.compiler.datamodel.YangIdentity id) Gets the derived package of YangIdentity.
static JavaQualifiedTypeInfoTranslator	getDerivedPkfInfo(org.onosproject.yang.compiler.datamodel.YangIdentity id) Returns package info of derived identity.
static File	getFileObject(String filePath, String fileName, String extension, JavaFileInfoTranslator handler) Returns a file object for generated file.
static String	getIdName(org.onosproject.yang.compiler.datamodel.YangIdentity id) Returns Identity name of the Identity.
static org.onosproject.yang.compiler.datamodel.YangDataStructure	getYangDataStructure(org.onosproject.yang.compiler.datamodel.YangCompilerAnnotation annotation) Returns YANG data structure from java attribute.
static void	initiateJavaFileGeneration(File file, int genType, List<String> imports, org.onosproject.yang.compiler.datamodel.YangNode curNode, String name) Initiates generation of file based on generated file type.
static void	initiateJavaFileGeneration(File file, String className, int genType, List<String> imports, String pkg) Initiates generation of file based on generated file type.
static org.onosproject.yang.compiler.datamodel.YangType	isTypeLeafref(org.onosproject.yang.compiler.datamodel.YangType<?> attributeType) Checks if the type is leafref and returns the effective type.
static String	isTypeNameLeafref(String attributeName, org.onosproject.yang.compiler.datamodel.YangType<?> attributeType) Checks if the type name is leafref and returns the effective type name.

Methods inherited from class java.lang.Object

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

Method Detail

getFileObject

public static File getFileObject(String filePath,
                                 String fileName,
                                 String extension,
                                 JavaFileInfoTranslator handler)

Returns a file object for generated file.

Parameters:

filePath - file package path

fileName - file name

extension - file extension

handler - cached file handle

Returns:

file object

initiateJavaFileGeneration

public static void initiateJavaFileGeneration(File file,
                                              String className,
                                              int genType,
                                              List<String> imports,
                                              String pkg)
                                       throws IOException

Initiates generation of file based on generated file type.

Parameters:

file - generated file

className - generated file class name

genType - generated file type

imports - imports for the file

pkg - generated file package

Throws:

IOException - when fails to generate a file

initiateJavaFileGeneration

public static void initiateJavaFileGeneration(File file,
                                              int genType,
                                              List<String> imports,
                                              org.onosproject.yang.compiler.datamodel.YangNode curNode,
                                              String name)
                                       throws IOException

Initiates generation of file based on generated file type.

Parameters:

file - generated file

genType - generated file type

imports - imports for the file

curNode - current YANG node

name - class name

Throws:

IOException - when fails to generate a file

isTypeNameLeafref

public static String isTypeNameLeafref(String attributeName,
                                       org.onosproject.yang.compiler.datamodel.YangType<?> attributeType)

Checks if the type name is leafref and returns the effective type name.

Parameters:

attributeName - name of the current type

attributeType - effective type

Returns:

name of the effective type

isTypeLeafref

public static org.onosproject.yang.compiler.datamodel.YangType isTypeLeafref(org.onosproject.yang.compiler.datamodel.YangType<?> attributeType)

Checks if the type is leafref and returns the effective type.

Parameters:

attributeType - current type

Returns:

effective type

getDerivedPkfInfo

public static JavaQualifiedTypeInfoTranslator getDerivedPkfInfo(org.onosproject.yang.compiler.datamodel.YangIdentity id)

Returns package info of derived identity.

Parameters:

id - YANG identity.

Returns:

derived package info.

getIdName

public static String getIdName(org.onosproject.yang.compiler.datamodel.YangIdentity id)

Returns Identity name of the Identity.

Parameters:

id - YANG identity.

Returns:

YANG identity name.

getAddToListMethodInterface

public static String getAddToListMethodInterface(JavaAttributeInfo attr,
                                                 String className)

Returns add to list method interface.

Parameters:

attr - java attribute

className - name of the class

Returns:

add to list method interface

getYangDataStructure

public static org.onosproject.yang.compiler.datamodel.YangDataStructure getYangDataStructure(org.onosproject.yang.compiler.datamodel.YangCompilerAnnotation annotation)

Returns YANG data structure from java attribute.

Parameters:

annotation - compiler annotation

Returns:

YANG data structure from java attribute

getCompareToForKeyClass

public static String getCompareToForKeyClass(List<JavaAttributeInfo> attrs,
                                             String className)

Returns compare to method for key class.

Parameters:

attrs - attribute list

className - class name

Returns:

compare to method

getDerivedPackage

public static String getDerivedPackage(org.onosproject.yang.compiler.datamodel.YangIdentity id)

Gets the derived package of YangIdentity.

Parameters:

id - YANG Identity.

Returns:

package of identity.