org.opendaylight.mdsal.binding.javav2.generator.util

Class BindingGeneratorUtil

java.lang.Object

org.opendaylight.mdsal.binding.javav2.generator.util.BindingGeneratorUtil

@Beta
public final class BindingGeneratorUtil
extends Object

Standard Util class that contains various method for converting input strings to valid JAVA language strings e.g. package names, class names, attribute names and/or 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 parentAugmentPackageName, org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode augmentationSchema) Creates package name from parentAugmentPackageName (package name for direct parent augmentation) and augmentationSchema .
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, BindingNamespaceType namespaceType) Creates package name from specified basePackageName (package name for module) and schemaPath.
static String	packageNameForSubGeneratedType(String basePackageName, org.opendaylight.yangtools.yang.model.api.SchemaNode node, BindingNamespaceType namespaceType)
static String	packageNameWithNamespacePrefix(String basePackageName, BindingNamespaceType namespaceType) Creates package name from specified basePackageName (package name for module) and namespaceType.
static String	replaceAllIllegalChars(CharSequence stringBuilder)
static String	replacePackageTopNamespace(String basePackageName, String toReplacePackageName, BindingNamespaceType toReplaceNameSpace, BindingNamespaceType replacedNameSpace)

Methods inherited from class java.lang.Object

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

Method Detail

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

computeDefaultSUID

public static long computeDefaultSUID(GeneratedTypeBuilderBase<?> to)

packageNameForGeneratedType

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

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.

Based on type of node, there is also possible suffix added in order to prevent package name conflicts.

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

packageNameWithNamespacePrefix

public static String packageNameWithNamespacePrefix(String basePackageName,
                                                    BindingNamespaceType namespaceType)

Creates package name from specified basePackageName (package name for module) and namespaceType.

Resulting package name is concatenation of basePackageName and prefix of namespaceType.

Parameters:

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

namespaceType - the namespace to which the module belongs

Returns:

string with valid JAVA package name

Throws:

NullPointerException - if any of the arguments are null

getRestrictions

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

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.

Based on type of node, there is also possible suffix added in order to prevent package name conflicts.

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 parentAugmentPackageName,
                                                          org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode augmentationSchema)

Creates package name from parentAugmentPackageName (package name for direct parent augmentation) and augmentationSchema .

Resulting package name is concatenation of parentAugmentPackageName and the local name of schemaPath.

Based on type of node, there is also possible suffix added in order to prevent package name conflicts.

Parameters:

parentAugmentPackageName - string with package name of direct parent augmentation, MUST be normalized, otherwise this method may return an invalid string.

augmentationSchema - augmentation schema which is direct son of parent augmentation.

Returns:

string with valid JAVA package name

Throws:

NullPointerException - if any of the arguments are null

packageNameForSubGeneratedType

public static String packageNameForSubGeneratedType(String basePackageName,
                                                    org.opendaylight.yangtools.yang.model.api.SchemaNode node,
                                                    BindingNamespaceType namespaceType)

replacePackageTopNamespace

public static String replacePackageTopNamespace(String basePackageName,
                                                String toReplacePackageName,
                                                BindingNamespaceType toReplaceNameSpace,
                                                BindingNamespaceType replacedNameSpace)

replaceAllIllegalChars

public static String replaceAllIllegalChars(CharSequence stringBuilder)