org.opendaylight.mdsal.binding.spec.naming

Class BindingMapping

java.lang.Object

org.opendaylight.mdsal.binding.spec.naming.BindingMapping

@Beta
public final class BindingMapping
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUGMENTABLE_AUGMENTATION_NAME Name of Augmentable.augmentation(Class).
static String	AUGMENTATION_FIELD
static String	BOOLEAN_GETTER_PREFIX Prefix for getter methods working on top of boolean.
static String	DATA_CONTAINER_GET_IMPLEMENTED_INTERFACE_NAME Name of DataContainer.getImplementedInterface().
static String	DATA_ROOT_SUFFIX
static String	GETTER_PREFIX Prefix for normal getter methods.
static String	IDENTIFIABLE_KEY_NAME Name of Identifiable.key().
static Set<String>	JAVA_RESERVED_WORDS
static String	MODEL_BINDING_PROVIDER_CLASS_NAME
static String	MODULE_INFO_CLASS_NAME
static String	MODULE_INFO_QNAMEOF_METHOD_NAME
static String	NONNULL_PREFIX Prefix for non-null default wrapper methods.
static String	NOTIFICATION_LISTENER_SUFFIX
static String	PACKAGE_PREFIX
static String	QNAME_STATIC_FIELD_NAME
static String	RPC_INPUT_SUFFIX
static String	RPC_OUTPUT_SUFFIX
static String	RPC_SERVICE_SUFFIX
static String	VERSION

Method Summary

Modifier and Type	Method and Description
static String	getClassName(org.opendaylight.yangtools.yang.common.QName name)
static String	getClassName(String localName)
static String	getGetterMethodForNonnull(String methodName)
static String	getGetterMethodName(org.opendaylight.yangtools.yang.common.QName name, boolean isBoolean)
static String	getGetterMethodName(String localName, boolean isBoolean)
static String	getGetterPrefix(boolean isBoolean)
static String	getGetterSuffix(org.opendaylight.yangtools.yang.common.QName name)
static String	getMethodName(org.opendaylight.yangtools.yang.common.QName name)
static String	getMethodName(String yangIdentifier)
static String	getNonnullMethodName(String localName)
static String	getPropertyName(String yangIdentifier)
static String	getRootPackageName(org.opendaylight.yangtools.yang.common.QName module)
static String	getRootPackageName(org.opendaylight.yangtools.yang.common.QNameModule module)
static boolean	isGetterMethodName(String methodName)
static boolean	isNonnullMethodName(String methodName)
static com.google.common.collect.BiMap<String,String>	mapEnumAssignedNames(Collection<String> assignedNames) Returns Java identifiers, conforming to JLS9 Section 3.8 to use for specified YANG assigned names (RFC7950 Section 9.6.4).
static String	normalizePackageName(String packageName)
static String	toFirstUpper(String str) Returns the String s with an upper case first character.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

JAVA_RESERVED_WORDS

public static final Set<String> JAVA_RESERVED_WORDS

DATA_ROOT_SUFFIX

public static final String DATA_ROOT_SUFFIX

See Also:

Constant Field Values

RPC_SERVICE_SUFFIX

public static final String RPC_SERVICE_SUFFIX

See Also:

Constant Field Values

NOTIFICATION_LISTENER_SUFFIX

public static final String NOTIFICATION_LISTENER_SUFFIX

See Also:

Constant Field Values

QNAME_STATIC_FIELD_NAME

public static final String QNAME_STATIC_FIELD_NAME

See Also:

Constant Field Values

PACKAGE_PREFIX

public static final String PACKAGE_PREFIX

See Also:

Constant Field Values

AUGMENTATION_FIELD

public static final String AUGMENTATION_FIELD

See Also:

Constant Field Values

MODULE_INFO_CLASS_NAME

public static final String MODULE_INFO_CLASS_NAME

See Also:

Constant Field Values

MODULE_INFO_QNAMEOF_METHOD_NAME

public static final String MODULE_INFO_QNAMEOF_METHOD_NAME

See Also:

Constant Field Values

MODEL_BINDING_PROVIDER_CLASS_NAME

public static final String MODEL_BINDING_PROVIDER_CLASS_NAME

See Also:

Constant Field Values

AUGMENTABLE_AUGMENTATION_NAME

public static final String AUGMENTABLE_AUGMENTATION_NAME

Name of Augmentable.augmentation(Class).

See Also:

Constant Field Values

IDENTIFIABLE_KEY_NAME

public static final String IDENTIFIABLE_KEY_NAME

Name of Identifiable.key().

See Also:

Constant Field Values

DATA_CONTAINER_GET_IMPLEMENTED_INTERFACE_NAME

public static final String DATA_CONTAINER_GET_IMPLEMENTED_INTERFACE_NAME

Name of DataContainer.getImplementedInterface().

See Also:

Constant Field Values

BOOLEAN_GETTER_PREFIX

public static final String BOOLEAN_GETTER_PREFIX

Prefix for getter methods working on top of boolean.

See Also:

Constant Field Values

GETTER_PREFIX

public static final String GETTER_PREFIX

Prefix for normal getter methods.

See Also:

Constant Field Values

NONNULL_PREFIX

public static final String NONNULL_PREFIX

Prefix for non-null default wrapper methods. These methods always wrap a corresponding normal getter.

See Also:

Constant Field Values

RPC_INPUT_SUFFIX

public static final String RPC_INPUT_SUFFIX

See Also:

Constant Field Values

RPC_OUTPUT_SUFFIX

public static final String RPC_OUTPUT_SUFFIX

See Also:

Constant Field Values

Method Detail

getRootPackageName

public static String getRootPackageName(org.opendaylight.yangtools.yang.common.QName module)

getRootPackageName

public static String getRootPackageName(org.opendaylight.yangtools.yang.common.QNameModule module)

normalizePackageName

public static String normalizePackageName(String packageName)

getClassName

public static String getClassName(String localName)

getClassName

public static String getClassName(org.opendaylight.yangtools.yang.common.QName name)

getMethodName

public static String getMethodName(String yangIdentifier)

getMethodName

public static String getMethodName(org.opendaylight.yangtools.yang.common.QName name)

getGetterPrefix

public static String getGetterPrefix(boolean isBoolean)

getGetterMethodName

public static String getGetterMethodName(String localName,
                                         boolean isBoolean)

getGetterMethodName

public static String getGetterMethodName(org.opendaylight.yangtools.yang.common.QName name,
                                         boolean isBoolean)

isGetterMethodName

public static boolean isGetterMethodName(String methodName)

getGetterMethodForNonnull

public static String getGetterMethodForNonnull(String methodName)

getNonnullMethodName

public static String getNonnullMethodName(String localName)

isNonnullMethodName

public static boolean isNonnullMethodName(String methodName)

getGetterSuffix

public static String getGetterSuffix(org.opendaylight.yangtools.yang.common.QName name)

getPropertyName

public static String getPropertyName(String yangIdentifier)

toFirstUpper

public static String toFirstUpper(String str)

Returns the String s with an upper case first character. This function is null-safe.

Parameters:

str - the string that should get an upper case first character. May be null.

Returns:

the String str with an upper case first character or null if the input String str was null.

mapEnumAssignedNames

public static com.google.common.collect.BiMap<String,String> mapEnumAssignedNames(Collection<String> assignedNames)

Returns Java identifiers, conforming to JLS9 Section 3.8 to use for specified YANG assigned names (RFC7950 Section 9.6.4). This method considers two distinct encodings: one the pre-Fluorine mapping, which is okay and convenient for sane strings, and an escaping-based bijective mapping which works for all possible Unicode strings.

Parameters:

assignedNames - Collection of assigned names

Returns:

A BiMap keyed by assigned name, with Java identifiers as values

Throws:

NullPointerException - if assignedNames is null or contains null items

IllegalArgumentException - if any of the names is empty