org.opendaylight.mdsal.binding.javav2.model.api

Interface GeneratedType

All Superinterfaces:

DocumentedType, Type

All Known Subinterfaces:

Enumeration, GeneratedTransferObject

@Beta
public interface GeneratedType
extends Type, DocumentedType

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

By the definition of the interface constant, enum, enclosed types and method definitions MUST be public, so there is no need to specify the scope of visibility.

Method Summary

Modifier and Type	Method and Description
List<AnnotationType>	getAnnotations() Returns List of annotation definitions associated with generated type.
BindingNamespaceType	getBindingNamespaceType() Get the BindingNamespaceType.
TypeComment	getComment() Returns comment string associated with Generated Type.
List<Constant>	getConstantDefinitions() Returns List of Constant definitions associated with Generated Type.
List<GeneratedType>	getEnclosedTypes() Returns List of enclosing Generated Types.
List<Enumeration>	getEnumerations() Returns List of all Enumerator definitions associated with Generated Type.
List<Type>	getImplements() Returns List of Types that Generated Type will implement.
List<MethodSignature>	getMethodDefinitions() Returns List of Method Definitions associated with Generated Type.
Type	getParentType() Returns the parent type if Generated Type is defined as enclosing type, otherwise returns null
Type	getParentTypeForBuilder() Returns parent type for data schema node builder
List<GeneratedProperty>	getProperties() Returns List of Properties that are declared for Generated Transfer Object.
Optional<YangSourceDefinition>	getYangSourceDefinition() Returns the YANG definition of this type, if available.
boolean	isAbstract() Returns true if The Generated Type is defined as abstract.

Methods inherited from interface org.opendaylight.mdsal.binding.javav2.model.api.Type

getFullyQualifiedName, getName, getPackageName

Methods inherited from interface org.opendaylight.mdsal.binding.javav2.model.api.DocumentedType

getDescription, getModuleName, getReference, getSchemaPath

Method Detail

getParentType

Type getParentType()

Returns the parent type if Generated Type is defined as enclosing type, otherwise returns null

Returns:

the parent type if Generated Type is defined as enclosing type, otherwise returns null

getComment

TypeComment getComment()

Returns comment string associated with Generated Type.

Returns:

comment string associated with Generated Type.

getAnnotations

List<AnnotationType> getAnnotations()

Returns List of annotation definitions associated with generated type.

Returns:

List of annotation definitions associated with generated type.

isAbstract

boolean isAbstract()

Returns true if The Generated Type is defined as abstract.

Returns:

true if The Generated Type is defined as abstract.

getImplements

List<Type> getImplements()

Returns List of Types that Generated Type will implement.

Returns:

List of Types that Generated Type will implement.

getEnclosedTypes

List<GeneratedType> getEnclosedTypes()

Returns List of enclosing Generated Types.

Returns:

List of enclosing Generated Types.

getEnumerations

List<Enumeration> getEnumerations()

Returns List of all Enumerator definitions associated with Generated Type.

Returns:

List of all Enumerator definitions associated with Generated Type.

getConstantDefinitions

List<Constant> getConstantDefinitions()

Returns List of Constant definitions associated with Generated Type.

Returns:

List of Constant definitions associated with Generated Type.

getMethodDefinitions

List<MethodSignature> getMethodDefinitions()

Returns List of Method Definitions associated with Generated Type. List does not contains getters and setters for properties.

Returns:

List of Method Definitions associated with Generated Type.

getProperties

List<GeneratedProperty> getProperties()

Returns List of Properties that are declared for Generated Transfer Object.

Returns:

List of Properties that are declared for Generated Transfer Object.

getParentTypeForBuilder

Type getParentTypeForBuilder()

Returns parent type for data schema node builder

getYangSourceDefinition

Optional<YangSourceDefinition> getYangSourceDefinition()

Returns the YANG definition of this type, if available.

Returns:

YANG source definition, or empty when unavailable.

getBindingNamespaceType

BindingNamespaceType getBindingNamespaceType()

Get the BindingNamespaceType.

Returns:

BindingNamespaceType which type belongs to.