org.onosproject.yang.compiler.utils.io.impl

Class YangIoUtils

java.lang.Object

org.onosproject.yang.compiler.utils.io.impl.YangIoUtils

public final class YangIoUtils
extends Object

Represents common utility functionalities for code generation.

Method Summary

Modifier and Type	Method and Description
static void	addPackageInfo(File path, String classInfo, String pack, boolean isChildNode) Adds package info file for the created directory.
static File	createDirectories(String path) Creates the directory structure.
static void	deleteDirectory(String dir) Cleans the generated directory if already exist in source folder.
static File	formatFile(File dataFile) Formats the generated file.
static String	getAbsolutePackagePath(String baseCodeGenPath, String pathOfJavaPkg) Returns the absolute path of the package in canonical form.
static String	getCamelCase(String yangIdentifier, YangToJavaNamingConflictUtil conflictResolver) Returns the YANG identifier name as java identifier.
static String	getCapitalCase(String yangIdentifier) Returns the YANG identifier name as java identifier with first letter in capital.
static String	getDirectory(String baseCodeGenPath, String pathOfJavaPkg) Returns the directory path of the package in canonical form.
static String	getJavaPackageFromPackagePath(String packagePath) Returns the java Package from package path.
static String	getPackageDirPathFromJavaJPackage(String packagePath) Returns the directory path corresponding to java package.
static String	getPrefixForIdentifier(YangToJavaNamingConflictUtil conflictResolver) Prefix for adding with identifier and namespace, when it is a java keyword or starting with digits.
static String	getSmallCase(String yangIdentifier) Returns the YANG identifier name as java identifier with first letter in small.
static int	getVersionValue(String ver) Converts string to integer number for maven version.
static void	insertDataIntoJavaFile(File file, String data) Inserts data in the generated file.
static void	mergeJavaFiles(File appendFile, File srcFile) Merges the temp java files to main java files.
static String	parsePkg(String pack) Parses package and returns updated package.
static void	removeEmptyDirectory(String path) Removes empty directory.
static String	replaceLast(String valueString, String removalString, String replacingString) Replaces the last occurrence of a string with a given string.
static void	searchAndDeleteTempDir(String root) Searches and deletes generated temporary directories.
static String	trimAtLast(String valueString, String... removalString) Removes extra char from the string.

Methods inherited from class java.lang.Object

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

Method Detail

createDirectories

public static File createDirectories(String path)
                              throws IOException

Creates the directory structure.

Parameters:

path - directory path

Returns:

directory structure

Throws:

IOException - when fails to do IO operations

addPackageInfo

public static void addPackageInfo(File path,
                                  String classInfo,
                                  String pack,
                                  boolean isChildNode)
                           throws IOException

Adds package info file for the created directory.

Parameters:

path - directory path

classInfo - class info for the package

pack - package of the directory

isChildNode - is it a child node

Throws:

IOException - when fails to create package info file

parsePkg

public static String parsePkg(String pack)

Parses package and returns updated package.

Parameters:

pack - package needs to be updated

Returns:

updated package

deleteDirectory

public static void deleteDirectory(String dir)
                            throws IOException

Cleans the generated directory if already exist in source folder.

Parameters:

dir - generated directory in previous build

Throws:

IOException - when failed to delete directory

searchAndDeleteTempDir

public static void searchAndDeleteTempDir(String root)
                                   throws IOException

Searches and deletes generated temporary directories.

Parameters:

root - root directory

Throws:

IOException - when fails to do IO operations.

trimAtLast

public static String trimAtLast(String valueString,
                                String... removalString)

Removes extra char from the string.

Parameters:

valueString - string to be trimmed

removalString - extra chars

Returns:

new string

replaceLast

public static String replaceLast(String valueString,
                                 String removalString,
                                 String replacingString)

Replaces the last occurrence of a string with a given string.

Parameters:

valueString - string under operation

removalString - string to be replaced

replacingString - string with which replacement is to be done

Returns:

new string

getDirectory

public static String getDirectory(String baseCodeGenPath,
                                  String pathOfJavaPkg)

Returns the directory path of the package in canonical form.

Parameters:

baseCodeGenPath - base path where the generated files needs to be put

pathOfJavaPkg - java package of the file being generated

Returns:

absolute path of the package in canonical form

getAbsolutePackagePath

public static String getAbsolutePackagePath(String baseCodeGenPath,
                                            String pathOfJavaPkg)

Returns the absolute path of the package in canonical form.

Parameters:

baseCodeGenPath - base path where the generated files needs to be put

pathOfJavaPkg - java package of the file being generated

Returns:

absolute path of the package in canonical form

mergeJavaFiles

public static void mergeJavaFiles(File appendFile,
                                  File srcFile)
                           throws IOException

Merges the temp java files to main java files.

Parameters:

appendFile - temp file

srcFile - main file

Throws:

IOException - when fails to append contents

insertDataIntoJavaFile

public static void insertDataIntoJavaFile(File file,
                                          String data)
                                   throws IOException

Inserts data in the generated file.

Parameters:

file - file in which need to be inserted

data - data which need to be inserted

Throws:

IOException - when fails to insert into file

formatFile

public static File formatFile(File dataFile)
                       throws IOException

Formats the generated file.

Parameters:

dataFile - file in which need to verify all lines.

Returns:

updated file

Throws:

IOException - when fails to do IO operations.

getJavaPackageFromPackagePath

public static String getJavaPackageFromPackagePath(String packagePath)

Returns the java Package from package path.

Parameters:

packagePath - package path

Returns:

java package

getPackageDirPathFromJavaJPackage

public static String getPackageDirPathFromJavaJPackage(String packagePath)

Returns the directory path corresponding to java package.

Parameters:

packagePath - package path

Returns:

java package

getSmallCase

public static String getSmallCase(String yangIdentifier)

Returns the YANG identifier name as java identifier with first letter in small.

Parameters:

yangIdentifier - identifier in YANG file.

Returns:

corresponding java identifier

getCapitalCase

public static String getCapitalCase(String yangIdentifier)

Returns the YANG identifier name as java identifier with first letter in capital.

Parameters:

yangIdentifier - identifier in YANG file

Returns:

corresponding java identifier

getCamelCase

public static String getCamelCase(String yangIdentifier,
                                  YangToJavaNamingConflictUtil conflictResolver)

Returns the YANG identifier name as java identifier.

Parameters:

yangIdentifier - identifier in YANG file

conflictResolver - object of YANG to java naming conflict util

Returns:

corresponding java identifier

getPrefixForIdentifier

public static String getPrefixForIdentifier(YangToJavaNamingConflictUtil conflictResolver)

Prefix for adding with identifier and namespace, when it is a java keyword or starting with digits.

Parameters:

conflictResolver - object of YANG to java naming conflict util

Returns:

prefix which needs to be added

removeEmptyDirectory

public static void removeEmptyDirectory(String path)

Removes empty directory.

Parameters:

path - path to be checked

getVersionValue

public static int getVersionValue(String ver)

Converts string to integer number for maven version.

Parameters:

ver - version

Returns:

int value of version