org.opendaylight.mdsal.binding.model.util

Class BindingGeneratorUtil

java.lang.Object

org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil

public final class BindingGeneratorUtil
extends Object

Contains the methods for converting strings to valid JAVA language strings (package names, class names, attribute names) and to valid javadoc comments.

Method Summary

Modifier and Type	Method and Description
static long	computeDefaultSUID(GeneratedTypeBuilderBase<?> to)
static String	encodeAngleBrackets(String description) Encodes angle brackets in yang statement description.
static Restrictions	getRestrictions(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type)
static String	packageNameForAugmentedGeneratedType(String basePackageName, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath) Creates package name from specified basePackageName (package name for module) and schemaPath which crosses an augmentation.
static String	packageNameForGeneratedType(String basePackageName, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath) Creates package name from specified basePackageName (package name for module) and schemaPath.
static String	replaceAllIllegalChars(CharSequence stringBuilder)
static String	resolveJavaReservedWordEquivalency(String parameterName) Converts parameterName to valid JAVA parameter name.

Methods inherited from class java.lang.Object

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

Method Detail

resolveJavaReservedWordEquivalency

public static String resolveJavaReservedWordEquivalency(String parameterName)

Converts parameterName to valid JAVA parameter name. If the parameterName is one of the JAVA reserved words then it is prefixed with underscore character.

Parameters:

parameterName - string with the parameter name

Returns:

string with the admissible parameter name

packageNameForGeneratedType

public static String packageNameForGeneratedType(String basePackageName,
                                                 org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)

Creates package name from specified basePackageName (package name for module) and schemaPath. Resulting package name is concatenation of basePackageName and all local names of YANG nodes which are parents of some node for which schemaPath is specified.

Parameters:

basePackageName - string with package name of the module, MUST be normalized, otherwise this method may return an invalid string.

schemaPath - list of names of YANG nodes which are parents of some node + name of this node

Returns:

string with valid JAVA package name

Throws:

NullPointerException - if any of the arguments are null

packageNameForAugmentedGeneratedType

public static String packageNameForAugmentedGeneratedType(String basePackageName,
                                                          org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath)

Creates package name from specified basePackageName (package name for module) and schemaPath which crosses an augmentation. Resulting package name is concatenation of basePackageName and all local names of YANG nodes which are parents of some node for which schemaPath is specified.

Parameters:

basePackageName - string with package name of the module, MUST be normalized, otherwise this method may return an invalid string.

schemaPath - list of names of YANG nodes which are parents of some node + name of this node

Returns:

string with valid JAVA package name

Throws:

NullPointerException - if any of the arguments are null

computeDefaultSUID

public static long computeDefaultSUID(GeneratedTypeBuilderBase<?> to)

getRestrictions

public static Restrictions getRestrictions(org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> type)

encodeAngleBrackets

public static String encodeAngleBrackets(String description)

Encodes angle brackets in yang statement description.

Parameters:

description - description of a yang statement which is used to generate javadoc comments

Returns:

string with encoded angle brackets

replaceAllIllegalChars

public static String replaceAllIllegalChars(CharSequence stringBuilder)