org.opendaylight.mdsal.binding.javav2.generator.impl

Class BindingGeneratorImpl

java.lang.Object

org.opendaylight.mdsal.binding.javav2.generator.impl.BindingGeneratorImpl

All Implemented Interfaces:

BindingGenerator

@Beta
public class BindingGeneratorImpl
extends Object
implements BindingGenerator

Main class for Binding generator v2. Provides transformation of Schema Context to generated transfer objects. Process is accompanied with Twirl templates to generate particular Javadoc for related YANG elements.

Constructor Summary

Constructors

Constructor and Description
BindingGeneratorImpl(boolean verboseClassComments) Creates a new binding generator v2.

Method Summary

Modifier and Type	Method and Description
List<Type>	generateTypes(org.opendaylight.yangtools.yang.model.api.SchemaContext context) Resolves generated types from context schema nodes of all modules.
List<Type>	generateTypes(org.opendaylight.yangtools.yang.model.api.SchemaContext context, Set<org.opendaylight.yangtools.yang.model.api.Module> modules) Resolves generated types from context schema nodes only for modules specified in modules
Map<org.opendaylight.yangtools.yang.model.api.Module,ModuleContext>	getModuleContexts(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext) Return module contexts from generated types according to context.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingGeneratorImpl

public BindingGeneratorImpl(boolean verboseClassComments)

Creates a new binding generator v2.

Parameters:

verboseClassComments - generate verbose comments

Method Detail

generateTypes

public List<Type> generateTypes(org.opendaylight.yangtools.yang.model.api.SchemaContext context)

Resolves generated types from context schema nodes of all modules.

Generated types are created for modules, groupings, types, containers, lists, choices, augments, rpcs, notification, identities.

Specified by:

generateTypes in interface BindingGenerator

Parameters:

context - schema context which contains data about all schema nodes saved in modules

Returns:

list of types (usually GeneratedType GeneratedTransferObjectwhich are generated from context data.

Throws:

IllegalArgumentException - if arg context is null

IllegalStateException - if context contain no modules

See Also:

SchemaContext

generateTypes

public List<Type> generateTypes(org.opendaylight.yangtools.yang.model.api.SchemaContext context,
                                Set<org.opendaylight.yangtools.yang.model.api.Module> modules)

Resolves generated types from context schema nodes only for modules specified in modules

Generated types are created for modules, groupings, types, containers, lists, choices, augments, rpcs, notification, identities.

Specified by:

generateTypes in interface BindingGenerator

Parameters:

context - schema context which contains data about all schema nodes saved in modules

modules - set of modules for which schema nodes should be generated types

Returns:

list of types (usually GeneratedType or GeneratedTransferObject) which:

• are generated from context schema nodes and
• are also part of some of the module in modules set.

Throws:

IllegalArgumentException -

• if arg context is null or
• if arg modules is null

IllegalStateException - if context contain no modules

See Also:

Module, SchemaContext

getModuleContexts

public Map<org.opendaylight.yangtools.yang.model.api.Module,ModuleContext> getModuleContexts(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

Return module contexts from generated types according to context.

Parameters:

schemaContext - - for generating types

Returns:

module contexts