Package org.opendaylight.yangtools.binding.model.api

package org.opendaylight.yangtools.binding.model.api

Model of Java classes generated from YANG. Some information on naming:

• Type refers to a Java class, interface or primitive type. This is something that is used as the type specifier of a variable declaration.
• GeneratedType refers to a Java class or interface. It can either be a top-level or a nested class or interface.
• GeneratedTransferObject refers to GeneratedType, which is a concrete class. These are generated to encapsulate the YANG type hierarchy as expressed by 'typedef' and 'type' statement use. If it has a superclass, it is also referred to as an Extended Type.

Class	Description
AbstractType	It is used only as ancestor for other Types.
AccessModifier	Enum definition which provides four access modifiers that are described in Java programming language (Default, Private, Protected, Public).
AnnotationType	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	Annotation Type parameter interface.
BaseTypeWithRestrictions	The BaseTypeWithRestrictions is marker interface that encapsulates definition of java concrete type only with changed restriction values.
CodeGenerator	Transforms virtual data to the concrete code in programming language.
ConcreteType	The Concrete Type is marker interface that encapsulates definition of java concrete type.
Constant	Interface Contact is designed to hold and model java constant.
DocumentedType	Implementing this interface allows an object to hold information which are essential for generating java doc from type definition.
Enumeration	Interface provide methods for reading data of enumeration class.
Enumeration.Pair	Interface is used for reading enumeration item.
GeneratedProperty	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).
GeneratedTransferObject	Generated Transfer Object extends GeneratedType and is designed to represent Java Class.
GeneratedType	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. interface extends list of interfaces or java class implements list of interfaces) Each Generated Type can contain multiple enclosed definitions of Generated Types (i.e. interface can contain N enclosed interface definitions or enclosed classes) enum and constant definitions (i.e. each constant definition is by default defined as public static final + type (either primitive or object) and constant name method definitions with specified input parameters (with types) and return values
JavaTypeName	A type name.
MethodSignature	The Method Signature interface contains simplified meta model for java method definition.
MethodSignature.Parameter	The Parameter interface is designed to hold the information of method Parameter(s).
MethodSignature.ValueMechanics	Method return type mechanics.
ParameterizedType	Represents an instance of simple parameterized type such as List<String>.
Restrictions
Type	The Type interface defines the base type for all types defined in java.
TypeComment	Dedicated type for holding a class comment.
TypeMember	Common interface for variables and methods in class.
TypeMemberComment	Structured comment of a particular class member.
WildcardType	Marker interface which assign to object property that it is a bounded wildcard type.
YangSourceDefinition	DTO capturing the YANG source definition which lead to a GeneratedType being emitted.
YangSourceDefinition.Multiple
YangSourceDefinition.Single