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	moduleNamespaceToPackageName(org.opendaylight.yangtools.yang.model.api.Module module) Deprecated. USe BindingMapping.getRootPackageName(QNameModule) with Module.getQNameModule().
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	packageNameForGeneratedType(String basePackageName, org.opendaylight.yangtools.yang.model.api.SchemaPath schemaPath, boolean isUsesAugment) Deprecated. Use packageNameForGeneratedType(String, SchemaPath) or packageNameForAugmentedGeneratedType(String, SchemaPath) instead.
static String	packageNameForTypeDefinition(String basePackageName, org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDefinition) Deprecated. This method ignores typeDefinition argument and its result is only BindingMapping.normalizePackageName(basePackageName). Aside from tests, there is not a single user in OpenDaylight codebase, hence it can be considered buggy and defunct. It is scheduled for removal in Boron release.
static String	parseToClassName(String token) Deprecated. Use BindingMapping.getClassName(QName) instead.
static String	parseToValidParamName(String token) Deprecated. Use BindingMapping.getPropertyName(String) instead.
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

moduleNamespaceToPackageName

@Deprecated
public static String moduleNamespaceToPackageName(org.opendaylight.yangtools.yang.model.api.Module module)

Deprecated. USe BindingMapping.getRootPackageName(QNameModule) with Module.getQNameModule().

Converts module name to valid JAVA package name. The package name consists of:

• prefix - org.opendaylight.yang.gen.v
• module YANG version - org.opendaylight.yang.gen.v
• module namespace - invalid characters are replaced with dots
• revision prefix - .rev
• revision - YYYYMMDD (MM and DD aren't spread to the whole length)

Parameters:

module - module which contains data about namespace and revision date

Returns:

string with the valid JAVA package name

Throws:

IllegalArgumentException - if the revision date of the module equals null

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

packageNameForGeneratedType

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

Deprecated. Use packageNameForGeneratedType(String, SchemaPath) or packageNameForAugmentedGeneratedType(String, SchemaPath) instead.

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

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

isUsesAugment - boolean true if using augment

Returns:

string with valid JAVA package name

packageNameForTypeDefinition

@Deprecated
public static String packageNameForTypeDefinition(String basePackageName,
                                                              org.opendaylight.yangtools.yang.model.api.TypeDefinition<?> typeDefinition)

Deprecated. This method ignores typeDefinition argument and its result is only BindingMapping.normalizePackageName(basePackageName). Aside from tests, there is not a single user in OpenDaylight codebase, hence it can be considered buggy and defunct. It is scheduled for removal in Boron release.

Generates the package name for type definition from typeDefinition and basePackageName.

Parameters:

basePackageName - string with the package name of the module

typeDefinition - type definition for which the package name will be generated *

Returns:

string with valid JAVA package name

Throws:

IllegalArgumentException -

• if basePackageName equals null
• if typeDefinition equals null

parseToClassName

@Deprecated
public static String parseToClassName(String token)

Deprecated. Use BindingMapping.getClassName(QName) instead.

Converts token to string which is in accordance with best practices for JAVA class names.

Parameters:

token - string which contains characters which should be converted to JAVA class name

Returns:

string which is in accordance with best practices for JAVA class name.

parseToValidParamName

@Deprecated
public static String parseToValidParamName(String token)

Deprecated. Use BindingMapping.getPropertyName(String) instead.

Converts token to string which is in accordance with best practices for JAVA parameter names.

Parameters:

token - string which contains characters which should be converted to JAVA parameter name

Returns:

string which is in accordance with best practices for JAVA parameter name.

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)