Index

A B C D E F G H I J L M N O P R S T U V W Y 
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractType - Class in org.opendaylight.mdsal.binding.model.api
It is used only as ancestor for other Types.
AbstractType(JavaTypeName) - Constructor for class org.opendaylight.mdsal.binding.model.api.AbstractType
Constructs the instance of this class with a JavaTypeName.
AccessModifier - Enum Class in org.opendaylight.mdsal.binding.model.api
Enum definition which provides four access modifiers that are described in Java programming language (Default, Private, Protected, Public).
addAnnotation(String, String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.AnnotableTypeBuilder
The method creates new AnnotationTypeBuilder containing specified package name an annotation name.
addAnnotation(String, String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.AnnotationTypeBuilder
The method creates new AnnotationTypeBuilder containing specified package name an annotation name.
addAnnotation(JavaTypeName) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.AnnotableTypeBuilder
The method creates new AnnotationTypeBuilder containing specified package name an annotation name.
addComment(TypeComment) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Adds String definition of comment into Method Signature definition.
The comment String MUST NOT contain any comment specific chars (i.e.
addConstant(Type, String, Object) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Adds Constant definition and returns new Constant instance.
By definition Constant MUST be defined by return Type, Name and assigned value.
addEnclosingTransferObject(GeneratedTransferObject) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Adds new Enclosing Transfer Object genTOBuilder into definition of Generated Type.
addEnumeration(Enumeration) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Adds new Enumeration definition for Generated Type Builder and returns Enum Builder for specifying all Enum parameters.
If there is already Enumeration stored with the same name, the old enum will be simply overwritten byt new enum definition.
Name of Enumeration cannot be null, if it is null the method SHOULD throw IllegalArgumentException.
addEqualsIdentity(GeneratedPropertyBuilder) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
Add Property that will be part of equals definition.
addHashIdentity(GeneratedPropertyBuilder) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
Add Property that will be part of hashCode definition.
addImplementsType(Type) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Add Type to implements.
addMethod(String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Add new Method Signature definition for Generated Type Builder and returns Method Signature Builder for specifying all Method parameters.
Name of Method cannot be null, if it is null the method SHOULD throw IllegalArgumentException.
By Default the MethodSignatureBuilder SHOULD be pre-set as MethodSignatureBuilder.setAbstract(boolean), {TypeMemberBuilder#setFinal(boolean)} and {TypeMemberBuilder#setAccessModifier(boolean)}
addParameter(String, String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.AnnotationTypeBuilder
Adds the parameter into List of parameters for Annotation Type.
addParameter(Type, String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder
Adds Parameter into the List of method parameters.
addParameters(String, List<String>) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.AnnotationTypeBuilder
Adds the parameter with specified List of parameter values into List of parameters for Annotation Type.
addProperty(String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Add new Generated Property definition for Generated Transfer Object Builder and returns Generated Property Builder for specifying Property.
Name of Property cannot be null, if it is null the method SHOULD throw IllegalArgumentException.
addToStringProperty(GeneratedPropertyBuilder) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
Add Property that will be part of toString definition.
AnnotableTypeBuilder - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
Common interface for java type builders which allow attaching annotations to them.
AnnotationType - Interface in org.opendaylight.mdsal.binding.model.api
The Annotation Type interface is designed to hold information about annotation for any type that could be annotated in Java.
For sake of simplicity the Annotation Type is not designed to model exact behaviour of annotation mechanism, but just to hold information needed to model annotation over java Type definition.
AnnotationType.Parameter - Interface in org.opendaylight.mdsal.binding.model.api
Annotation Type parameter interface.
AnnotationTypeBuilder - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
Annotation Type Builder Interface serves for creation and instantiation of immutable copy of Annotation Type.
assignValue(Object) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.ConstantBuilder
 

B

BaseTypeWithRestrictions - Interface in org.opendaylight.mdsal.binding.model.api
The BaseTypeWithRestrictions is marker interface that encapsulates definition of java concrete type only with changed restriction values.
build() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.AnnotationTypeBuilder
Returns new immutable instance of Annotation Type with values assigned in current instance of Annotation Type Builder.
build() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
Returns instance of GeneratedTransferObject which data are build from the data of this builder.
build() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder
Returns the new immutable instance of Generated Type.

C

canCreateEnclosed(String) - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Check if an enclosed type with specified name can be created.
CodeGenerator - Interface in org.opendaylight.mdsal.binding.model.api
Transforms virtual data to the concrete code in programming language.
ConcreteType - Interface in org.opendaylight.mdsal.binding.model.api
The Concrete Type is marker interface that encapsulates definition of java concrete type.
Constant - Interface in org.opendaylight.mdsal.binding.model.api
Interface Contact is designed to hold and model java constant.
ConstantBuilder - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
 
containsMethod(String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Checks if GeneratedTypeBuilder contains method with name methodName.
containsParameters() - Method in interface org.opendaylight.mdsal.binding.model.api.AnnotationType
Returns true if annotation contains parameters.
containsProperty(String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Check whether GeneratedTOBuilder contains property with name name.
contractDescription() - Method in class org.opendaylight.mdsal.binding.model.api.TypeMemberComment
Return the member contract description.
contractOf(String) - Static method in class org.opendaylight.mdsal.binding.model.api.TypeMemberComment
 
create(Class<?>) - Static method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Create a TypeName for an existing class.
create(String, String) - Static method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Create a TypeName for a top-level class.
createEnclosed(String) - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Create a TypeName for a class immediately enclosed by this class.
createEnclosed(String, String) - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Create a TypeName for a class immediately enclosed by this class, potentially falling back to appending it with a suffix if a JLS hiding conflict occurs.
createSibling(String) - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Create a TypeName for a class that is a sibling of this class.

D

DEFAULT - Enum constant in enum class org.opendaylight.mdsal.binding.model.api.AccessModifier
 
DocumentedType - Interface in org.opendaylight.mdsal.binding.model.api
Implementing this interface allows an object to hold information which are essential for generating java doc from type definition.

E

empty() - Static method in class org.opendaylight.mdsal.binding.model.api.Restrictions
 
EnumBuilder - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
Enum Builder is interface that contains methods to build and instantiate Enumeration definition.
Enumeration - Interface in org.opendaylight.mdsal.binding.model.api
Interface provide methods for reading data of enumeration class.
Enumeration.Pair - Interface in org.opendaylight.mdsal.binding.model.api
Interface is used for reading enumeration item.
equals(Object) - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
 
equals(Object) - Method in class org.opendaylight.mdsal.binding.model.api.AbstractType
 
equals(Object) - Method in class org.opendaylight.mdsal.binding.model.api.TypeMemberComment
 

F

findProperty(String) - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
 

G

generate(Type) - Method in interface org.opendaylight.mdsal.binding.model.api.CodeGenerator
Generates code for type.
GeneratedProperty - Interface in org.opendaylight.mdsal.binding.model.api
Generated Property extends TypeMember interface with additional information about fields (and other members) declared in Java Transfer Objects (or any java classes) and their access counterparts (getters and setters).
GeneratedPropertyBuilder - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
Generated Property Builder is interface that contains methods to build and instantiate Generated Property definition.
GeneratedTOBuilder - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
Generated Transfer Object Builder is interface that contains methods to build and instantiate Generated Transfer Object definition.
GeneratedTransferObject - Interface in org.opendaylight.mdsal.binding.model.api
Generated Transfer Object extends GeneratedType and is designed to represent Java Class.
GeneratedType - Interface in org.opendaylight.mdsal.binding.model.api
Every Java interface has to be specified with: package that belongs into interface name (with commentary that SHOULD be present to proper define interface and base contracts specified for interface) Each Generated Type can define list of types that Generated Type can implement to extend it's definition (i.e.
GeneratedTypeBuilder - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
Generated Type Builder interface is helper interface for building and defining the GeneratedType.
GeneratedTypeBuilderBase<T extends GeneratedTypeBuilderBase<T>> - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
 
getAccessModifier() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.TypeMemberBuilder
 
getAccessModifier() - Method in interface org.opendaylight.mdsal.binding.model.api.TypeMember
Returns the access modifier of member.
getActualTypeArguments() - Method in interface org.opendaylight.mdsal.binding.model.api.ParameterizedType
Returns array of Types that are defined for Parameterized Type.
getAnnotations() - Method in interface org.opendaylight.mdsal.binding.model.api.AnnotationType
Returns the List of Annotations.
getAnnotations() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns List of annotation definitions associated with generated type.
getAnnotations() - Method in interface org.opendaylight.mdsal.binding.model.api.TypeMember
Returns List of annotation definitions associated with generated type.
getBaseType() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
Returns Base type of Java representation of YANG typedef if set, otherwise it returns null.
getComment() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns comment string associated with Generated Type.
getComment() - Method in interface org.opendaylight.mdsal.binding.model.api.TypeMember
Returns comment string associated with member.
getConstantDefinitions() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns List of Constant definitions associated with Generated Type.
getDescription() - Method in interface org.opendaylight.mdsal.binding.model.api.DocumentedType
Returns a string that contains a human-readable textual description of type definition.
getEnclosedTypes() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns List of enclosing Generated Types.
getEnumerations() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns List of all Enumerator definitions associated with Generated Type.
getEqualsIdentifiers() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
Returns List of Properties that are designated to define equality for Generated Transfer Object.
getFullyQualifiedName() - Method in interface org.opendaylight.mdsal.binding.model.api.Type
Returns fully qualified name of Type.
getHashCodeIdentifiers() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
Returns List of Properties that are designated to define identity for Generated Transfer Object.
getImplements() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns List of Types that Generated Type will implement.
getImplementsTypes() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
 
getJavadoc() - Method in interface org.opendaylight.mdsal.binding.model.api.TypeComment
Return a javadoc snippet.
getLengthConstraint() - Method in class org.opendaylight.mdsal.binding.model.api.Restrictions
 
getMappedName() - Method in interface org.opendaylight.mdsal.binding.model.api.Enumeration.Pair
Returns the binding representation for the name of the enumeration item.
getMechanics() - Method in interface org.opendaylight.mdsal.binding.model.api.MethodSignature
Return the mechanics associated with this method.
getMethodDefinitions() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns List of Method Definitions associated with Generated Type.
getMethodDefinitions() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
 
getModule() - Method in class org.opendaylight.mdsal.binding.model.api.YangSourceDefinition
Return the defining YANG module.
getModuleName() - Method in interface org.opendaylight.mdsal.binding.model.api.DocumentedType
Returns the name of the module, in which generated type was specified.
getName() - Method in interface org.opendaylight.mdsal.binding.model.api.AnnotationType.Parameter
Returns the Name of the parameter.
getName() - Method in interface org.opendaylight.mdsal.binding.model.api.Constant
Returns the name of constant.
getName() - Method in interface org.opendaylight.mdsal.binding.model.api.Enumeration.Pair
Returns the name of the enumeration item as it is specified in the input YANG.
getName() - Method in interface org.opendaylight.mdsal.binding.model.api.MethodSignature.Parameter
Returns the parameter name.
getName() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.TypeMemberBuilder
Returns the name of property.
getName() - Method in interface org.opendaylight.mdsal.binding.model.api.Type
Returns name of the interface.
getName() - Method in interface org.opendaylight.mdsal.binding.model.api.TypeMember
Returns the name of member.
getNode() - Method in class org.opendaylight.mdsal.binding.model.api.YangSourceDefinition.Single
Return the defining DocumentedNode.
getNodes() - Method in class org.opendaylight.mdsal.binding.model.api.YangSourceDefinition.Multiple
Return the defining SchemaNodes.
getPackageName() - Method in interface org.opendaylight.mdsal.binding.model.api.Type
Returns name of the package that interface belongs to.
getParameter(String) - Method in interface org.opendaylight.mdsal.binding.model.api.AnnotationType
Returns Parameter Definition assigned for given parameter name.
getParameterNames() - Method in interface org.opendaylight.mdsal.binding.model.api.AnnotationType
Returns List of parameter names.
getParameters() - Method in interface org.opendaylight.mdsal.binding.model.api.AnnotationType
Returns List of all parameters assigned to Annotation Type.
getParameters() - Method in interface org.opendaylight.mdsal.binding.model.api.MethodSignature
Returns the List of parameters that method declare.
getPatternConstraints() - Method in class org.opendaylight.mdsal.binding.model.api.Restrictions
 
getProperties() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns List of Properties that are declared for Generated Transfer Object.
getProperties() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
 
getRangeConstraint() - Method in class org.opendaylight.mdsal.binding.model.api.Restrictions
 
getRawType() - Method in interface org.opendaylight.mdsal.binding.model.api.ParameterizedType
Returns the Raw Type definition of Parameterized Type.
getReference() - Method in interface org.opendaylight.mdsal.binding.model.api.DocumentedType
Returns a string that is used to specify a textual cross-reference to an external document, either another module that defines related management information, or a document that provides additional information relevant to this definition.
getRestrictions() - Method in interface org.opendaylight.mdsal.binding.model.api.ConcreteType
 
getRestrictions() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
 
getReturnType() - Method in interface org.opendaylight.mdsal.binding.model.api.TypeMember
Get the returning Type of member.
getSUID() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
 
getSuperType() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
Returns the Generated Transfer Object from which this GTO is derived, or null if this GTO is not derived from a GTO -- e.g.
getToStringIdentifiers() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
Returns List of Properties that will be members of toString definition for Generated Transfer Object.
getType() - Method in interface org.opendaylight.mdsal.binding.model.api.Constant
Returns the return Type (or just Type) of the Constant.
getType() - Method in interface org.opendaylight.mdsal.binding.model.api.MethodSignature.Parameter
Returns Type that is bounded to parameter name.
getUnitName(Type) - Method in interface org.opendaylight.mdsal.binding.model.api.CodeGenerator
Returns name of type parameter.
getValue() - Method in interface org.opendaylight.mdsal.binding.model.api.AnnotationType.Parameter
Returns value in String format if Parameter contains singular value, otherwise MAY return null.
getValue() - Method in interface org.opendaylight.mdsal.binding.model.api.Constant
Returns boxed value that is assigned for context.
getValue() - Method in interface org.opendaylight.mdsal.binding.model.api.Enumeration.Pair
Returns value of the enumeration item.
getValue() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedProperty
 
getValues() - Method in interface org.opendaylight.mdsal.binding.model.api.AnnotationType.Parameter
Returns List of Parameter assigned values in order in which they were assigned for given parameter name.
If there are multiple values assigned for given parameter name the method MUST NOT return empty List.
getValues() - Method in interface org.opendaylight.mdsal.binding.model.api.Enumeration
Returns list of the couples - name and value.
getYangSourceDefinition() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns the YANG definition of this type, if available.
getYangSourceDefinition() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Returns the YANG definition of this type, if available.

H

hashCode() - Method in class org.opendaylight.mdsal.binding.model.api.AbstractType
 
hashCode() - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
 
hashCode() - Method in class org.opendaylight.mdsal.binding.model.api.TypeMemberComment
 

I

immediatelyEnclosingClass() - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Return the enclosing class JavaTypeName, if present.
isAbstract() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedType
Returns true if The Generated Type is defined as abstract.
isAbstract() - Method in interface org.opendaylight.mdsal.binding.model.api.MethodSignature
Returns true if the method signature is defined as abstract.
isAbstract() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
 
isAcceptable(Type) - Method in interface org.opendaylight.mdsal.binding.model.api.CodeGenerator
Checks if the concrete instance of type fit to concrete implementation of this interface (e.g.
isDefault() - Method in interface org.opendaylight.mdsal.binding.model.api.MethodSignature
Returns true if this method is a interface default method.
isEmpty() - Method in class org.opendaylight.mdsal.binding.model.api.Restrictions
 
isFinal() - Method in interface org.opendaylight.mdsal.binding.model.api.TypeMember
Returns true if member is declared as final.
isReadOnly() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedProperty
Returns true if the property is declared as read-only.
isStatic() - Method in interface org.opendaylight.mdsal.binding.model.api.TypeMember
Returns true if member is declared as static.
isTypedef() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
 
isUnion() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
 
isUnionType() - Method in interface org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
Return boolean value which describe whether Generated Transfer Object was created (or not) from union YANG type.

J

JavaTypeName - Class in org.opendaylight.mdsal.binding.model.api
A type name.

L

localName() - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Return the package-local name by which this type can be referenced by classes living in the same package.
localNameComponents() - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Return broken-down package-local name components.

M

MethodSignature - Interface in org.opendaylight.mdsal.binding.model.api
The Method Signature interface contains simplified meta model for java method definition.
MethodSignature.Parameter - Interface in org.opendaylight.mdsal.binding.model.api
The Parameter interface is designed to hold the information of method Parameter(s).
MethodSignature.ValueMechanics - Enum Class in org.opendaylight.mdsal.binding.model.api
Method return type mechanics.
MethodSignatureBuilder - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
Method Signature Builder serves solely for building Method Signature and returning the new instance of Method Signature.

N

NONNULL - Enum constant in enum class org.opendaylight.mdsal.binding.model.api.MethodSignature.ValueMechanics
Mechanics signaling that the method cannot legally return null.
NORMAL - Enum constant in enum class org.opendaylight.mdsal.binding.model.api.MethodSignature.ValueMechanics
Usual mechanics, nothing special is going on.
NULLIFY_EMPTY - Enum constant in enum class org.opendaylight.mdsal.binding.model.api.MethodSignature.ValueMechanics
Mechanics signaling that the method should not be returning empty collections, but rather squash tham to null.

O

of(LengthConstraint) - Static method in class org.opendaylight.mdsal.binding.model.api.Restrictions
 
of(RangeConstraint<?>) - Static method in class org.opendaylight.mdsal.binding.model.api.Restrictions
 
of(Class<?>) - Static method in interface org.opendaylight.mdsal.binding.model.api.Type
 
of(List<PatternConstraint>, LengthConstraint) - Static method in class org.opendaylight.mdsal.binding.model.api.Restrictions
 
of(JavaTypeName) - Static method in interface org.opendaylight.mdsal.binding.model.api.Type
 
of(Identifiable<JavaTypeName>) - Static method in interface org.opendaylight.mdsal.binding.model.api.Type
 
of(Module) - Static method in class org.opendaylight.mdsal.binding.model.api.YangSourceDefinition
 
of(Module, Collection<? extends SchemaNode>) - Static method in class org.opendaylight.mdsal.binding.model.api.YangSourceDefinition
 
of(Module, SchemaNode) - Static method in class org.opendaylight.mdsal.binding.model.api.YangSourceDefinition
 
of(ModuleEffectiveStatement, EffectiveStatement<?, ?>) - Static method in class org.opendaylight.mdsal.binding.model.api.YangSourceDefinition
 
of(ModuleEffectiveStatement, SchemaNode) - Static method in class org.opendaylight.mdsal.binding.model.api.YangSourceDefinition
 
org.opendaylight.mdsal.binding.model.api - module org.opendaylight.mdsal.binding.model.api
 
org.opendaylight.mdsal.binding.model.api - package org.opendaylight.mdsal.binding.model.api
Model of Java classes generated from YANG.
org.opendaylight.mdsal.binding.model.api.type.builder - package org.opendaylight.mdsal.binding.model.api.type.builder
 

P

packageName() - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Return the package name in which this class resides.
ParameterizedType - Interface in org.opendaylight.mdsal.binding.model.api
Represents an instance of simple parameterized type such as List<String>.
PRIVATE - Enum constant in enum class org.opendaylight.mdsal.binding.model.api.AccessModifier
 
PROTECTED - Enum constant in enum class org.opendaylight.mdsal.binding.model.api.AccessModifier
 
PUBLIC - Enum constant in enum class org.opendaylight.mdsal.binding.model.api.AccessModifier
 

R

referenceDescription() - Method in class org.opendaylight.mdsal.binding.model.api.TypeMemberComment
Return the member reference description.
referenceOf(String) - Static method in class org.opendaylight.mdsal.binding.model.api.TypeMemberComment
 
Restrictions - Class in org.opendaylight.mdsal.binding.model.api
 

S

setAbstract(boolean) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Sets the abstract flag to define Generated Type as abstract type.
setAbstract(boolean) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder
Sets the flag for declaration of method as abstract or non abstract.
setAccessModifier(AccessModifier) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.TypeMemberBuilder
Sets the access modifier of property.
setBaseType(TypeDefinition<?>) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
Sets the base type for Java representation of YANG typedef.
setComment(TypeMemberComment) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.TypeMemberBuilder
Adds String definition of comment into Method Signature definition.
setDefault(boolean) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder
Sets the flag indicating whether this is a default interface method.
setDescription(String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.EnumBuilder
 
setDescription(String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Set a string that contains a human-readable textual description of type definition.
setExtendsType(GeneratedTransferObject) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
Add Generated Transfer Object from which will be extended current Generated Transfer Object.
By definition Java does not allow multiple inheritance, hence if there is already a definition of an Generated Transfer Object the extending object will be overwritten by lastly added Generated Transfer Object.
If Generated Transfer Object is null the method SHOULD throw IllegalArgumentException
setFinal(boolean) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.TypeMemberBuilder
Sets the flag final for method signature.
setIsUnion(boolean) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
Sets the union flag.
setMechanics(MethodSignature.ValueMechanics) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder
 
setModuleName(String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Set the name of the module, in which generated type was specified.
setReadOnly(boolean) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder
Sets isReadOnly flag for property.
setReference(String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Set a string that is used to specify a textual cross-reference to an external document, either another module that defines related management information, or a document that provides additional information relevant to this definition.
setRestrictions(Restrictions) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
 
setReturnType(Type) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.TypeMemberBuilder
Adds return Type into Builder definition for Generated Property.
setStatic(boolean) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.TypeMemberBuilder
 
setSUID(GeneratedPropertyBuilder) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
 
setTypedef(boolean) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder
 
setValue(String) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder
 
setYangSourceDefinition(YangSourceDefinition) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilderBase
Set the YANG source definition.
simpleName() - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Return the simple name of the class.

T

toFormattedString() - Method in interface org.opendaylight.mdsal.binding.model.api.Enumeration
Formats enumeration according to rules of the programming language.
toInstance() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.ConstantBuilder
 
toInstance() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.EnumBuilder
 
toInstance() - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedPropertyBuilder
Returns new immutable instance of Generated Property.
toInstance(Type) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.MethodSignatureBuilder
Returns new immutable instance of Method Signature.
topLevelClass() - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Return the top-level class JavaTypeName which is containing this type, or self if this type is a top-level one.
toString() - Method in class org.opendaylight.mdsal.binding.model.api.JavaTypeName
Return the Fully-Qualified Class Name string of this TypeName.
toString() - Method in class org.opendaylight.mdsal.binding.model.api.TypeMemberComment
 
Type - Interface in org.opendaylight.mdsal.binding.model.api
The Type interface defines the base type for all types defined in java.
TypeComment - Interface in org.opendaylight.mdsal.binding.model.api
Dedicated type for holding a class comment.
TypeMember - Interface in org.opendaylight.mdsal.binding.model.api
Common interface for variables and methods in class.
TypeMemberBuilder<T extends TypeMemberBuilder<T>> - Interface in org.opendaylight.mdsal.binding.model.api.type.builder
 
TypeMemberComment - Class in org.opendaylight.mdsal.binding.model.api
Structured comment of a particular class member.
TypeMemberComment(String, String, String) - Constructor for class org.opendaylight.mdsal.binding.model.api.TypeMemberComment
 
typeSignature() - Method in class org.opendaylight.mdsal.binding.model.api.TypeMemberComment
Return the type signature of this type member.

U

updateEnumPairsFromEnumTypeDef(EnumTypeDefinition) - Method in interface org.opendaylight.mdsal.binding.model.api.type.builder.EnumBuilder
Updates this builder with data from enumTypeDef.

V

valueOf(String) - Static method in enum class org.opendaylight.mdsal.binding.model.api.AccessModifier
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.opendaylight.mdsal.binding.model.api.MethodSignature.ValueMechanics
Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.opendaylight.mdsal.binding.model.api.AccessModifier
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.opendaylight.mdsal.binding.model.api.MethodSignature.ValueMechanics
Returns an array containing the constants of this enum class, in the order they are declared.

W

WildcardType - Interface in org.opendaylight.mdsal.binding.model.api
Marker interface which assign to object property that it is a bounded wildcard type.

Y

YangSourceDefinition - Class in org.opendaylight.mdsal.binding.model.api
DTO capturing the YANG source definition which lead to a GeneratedType being emitted.
YangSourceDefinition.Multiple - Class in org.opendaylight.mdsal.binding.model.api
 
YangSourceDefinition.Single - Class in org.opendaylight.mdsal.binding.model.api
 
A B C D E F G H I J L M N O P R S T U V W Y 
All Classes and Interfaces|All Packages|Serialized Form