ModuleBuilder (yangtools 3.0.0-SNAPSHOT API)

java.lang.Object
- org.opendaylight.yangtools.yang.model.immutable.ModuleBuilder

```
@NotThreadSafe
public final class ModuleBuilder
extends Object
```
Builds instances of type AbstractModule. Initialize attributes and then invoke the build() method to create an immutable instance.
ModuleBuilder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Constructor Summary

Constructors
Constructor and Description

ModuleBuilder()
Creates a builder for AbstractModule instances.

Constructors
Constructor and Description
`ModuleBuilder()` Creates a builder for `AbstractModule` instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ModuleBuilder`	`addAllAugmentations(Iterable<? extends AugmentationSchemaNode> elements)` Adds elements to `augmentations` set.
`ModuleBuilder`	`addAllDeviations(Iterable<? extends Deviation> elements)` Adds elements to `deviations` set.
`ModuleBuilder`	`addAllExtensionSchemaNodes(Iterable<? extends ExtensionDefinition> elements)` Adds elements to `extensionSchemaNodes` list.
`ModuleBuilder`	`addAllFeatures(Iterable<? extends FeatureDefinition> elements)` Adds elements to `features` set.
`ModuleBuilder`	`addAllGroupings(Iterable<? extends GroupingDefinition> elements)` Adds elements to `groupings` set.
`ModuleBuilder`	`addAllIdentities(Iterable<? extends IdentitySchemaNode> elements)` Adds elements to `identities` set.
`ModuleBuilder`	`addAllImports(Iterable<? extends ModuleImport> elements)` Adds elements to `imports` set.
`ModuleBuilder`	`addAllNotifications(Iterable<? extends NotificationDefinition> elements)` Adds elements to `notifications` set.
`ModuleBuilder`	`addAllRpcs(Iterable<? extends RpcDefinition> elements)` Adds elements to `rpcs` set.
`ModuleBuilder`	`addAllSubmodules(Iterable<? extends Module> elements)` Adds elements to `submodules` set.
`ModuleBuilder`	`addAllTypeDefinitions(Iterable<? extends TypeDefinition<?>> elements)` Adds elements to `typeDefinitions` set.
`ModuleBuilder`	`addAllUses(Iterable<? extends UsesNode> elements)` Adds elements to `uses` set.
`ModuleBuilder`	`addAugmentations(AugmentationSchemaNode... elements)` Adds elements to `augmentations` set.
`ModuleBuilder`	`addAugmentations(AugmentationSchemaNode element)` Adds one element to `augmentations` set.
`ModuleBuilder`	`addDeviations(Deviation... elements)` Adds elements to `deviations` set.
`ModuleBuilder`	`addDeviations(Deviation element)` Adds one element to `deviations` set.
`ModuleBuilder`	`addExtensionSchemaNodes(ExtensionDefinition... elements)` Adds elements to `extensionSchemaNodes` list.
`ModuleBuilder`	`addExtensionSchemaNodes(ExtensionDefinition element)` Adds one element to `extensionSchemaNodes` list.
`ModuleBuilder`	`addFeatures(FeatureDefinition... elements)` Adds elements to `features` set.
`ModuleBuilder`	`addFeatures(FeatureDefinition element)` Adds one element to `features` set.
`ModuleBuilder`	`addGroupings(GroupingDefinition... elements)` Adds elements to `groupings` set.
`ModuleBuilder`	`addGroupings(GroupingDefinition element)` Adds one element to `groupings` set.
`ModuleBuilder`	`addIdentities(IdentitySchemaNode... elements)` Adds elements to `identities` set.
`ModuleBuilder`	`addIdentities(IdentitySchemaNode element)` Adds one element to `identities` set.
`ModuleBuilder`	`addImports(ModuleImport... elements)` Adds elements to `imports` set.
`ModuleBuilder`	`addImports(ModuleImport element)` Adds one element to `imports` set.
`ModuleBuilder`	`addNotifications(NotificationDefinition... elements)` Adds elements to `notifications` set.
`ModuleBuilder`	`addNotifications(NotificationDefinition element)` Adds one element to `notifications` set.
`ModuleBuilder`	`addRpcs(RpcDefinition... elements)` Adds elements to `rpcs` set.
`ModuleBuilder`	`addRpcs(RpcDefinition element)` Adds one element to `rpcs` set.
`ModuleBuilder`	`addSubmodules(Module... elements)` Adds elements to `submodules` set.
`ModuleBuilder`	`addSubmodules(Module element)` Adds one element to `submodules` set.
`ModuleBuilder`	`addTypeDefinitions(TypeDefinition<?>... elements)` Adds elements to `typeDefinitions` set.
`ModuleBuilder`	`addTypeDefinitions(TypeDefinition<?> element)` Adds one element to `typeDefinitions` set.
`ModuleBuilder`	`addUses(UsesNode... elements)` Adds elements to `uses` set.
`ModuleBuilder`	`addUses(UsesNode element)` Adds one element to `uses` set.
`org.opendaylight.yangtools.yang.model.immutable.AbstractModule`	`build()` Builds a new `AbstractModule`.
`ModuleBuilder`	`contact(Optional<String> contact)` Initializes the optional value `contact` to contact.
`ModuleBuilder`	`contact(String contact)` Initializes the optional value `contact` to contact.
`ModuleBuilder`	`description(Optional<String> description)` Initializes the optional value `description` to description.
`ModuleBuilder`	`description(String description)` Initializes the optional value `description` to description.
`ModuleBuilder`	`name(String name)` Initializes the value for the `name` attribute.
`ModuleBuilder`	`organization(Optional<String> organization)` Initializes the optional value `organization` to organization.
`ModuleBuilder`	`organization(String organization)` Initializes the optional value `organization` to organization.
`ModuleBuilder`	`prefix(String prefix)` Initializes the value for the `prefix` attribute.
`ModuleBuilder`	`putAllChildren(Map<? extends QName,? extends DataSchemaNode> entries)` Put all mappings from the specified map as entries to `children` map.
`ModuleBuilder`	`putChildren(Map.Entry<? extends QName,? extends DataSchemaNode> entry)` Put one entry to the `children` map.
`ModuleBuilder`	`putChildren(QName key, DataSchemaNode value)` Put one entry to the `children` map.
`ModuleBuilder`	`qNameModule(QNameModule qNameModule)` Initializes the value for the `qNameModule` attribute.
`ModuleBuilder`	`reference(Optional<String> reference)` Initializes the optional value `reference` to reference.
`ModuleBuilder`	`reference(String reference)` Initializes the optional value `reference` to reference.
`ModuleBuilder`	`semanticVersion(Optional<? extends SemVer> semanticVersion)` Initializes the optional value `semanticVersion` to semanticVersion.
`ModuleBuilder`	`semanticVersion(SemVer semanticVersion)` Initializes the optional value `semanticVersion` to semanticVersion.
`ModuleBuilder`	`yangVersion(YangVersion yangVersion)` Initializes the value for the `yangVersion` attribute.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ModuleBuilder
```
public ModuleBuilder()
```
    Creates a builder for AbstractModule instances.
- Method Detail
  - putChildren
```
public final ModuleBuilder putChildren(QName key,
                                       DataSchemaNode value)
```
    Put one entry to the children map.
    
    Parameters:
    
    key - The key in the children map
    
    value - The associated value in the children map
    
    Returns:
    
    this builder for use in a chained invocation
  - putChildren
```
public final ModuleBuilder putChildren(Map.Entry<? extends QName,? extends DataSchemaNode> entry)
```
    Put one entry to the children map. Nulls are not permitted
    
    Parameters:
    
    entry - The key and value entry
    
    Returns:
    
    this builder for use in a chained invocation
  - putAllChildren
```
public final ModuleBuilder putAllChildren(Map<? extends QName,? extends DataSchemaNode> entries)
```
    Put all mappings from the specified map as entries to children map. Nulls are not permitted
    
    Parameters:
    
    entries - The entries that will be added to the children map
    
    Returns:
    
    this builder for use in a chained invocation
  - addTypeDefinitions
```
public final ModuleBuilder addTypeDefinitions(TypeDefinition<?> element)
```
    Adds one element to typeDefinitions set.
    
    Parameters:
    
    element - A typeDefinitions element
    
    Returns:
    
    this builder for use in a chained invocation
  - addTypeDefinitions
```
@SafeVarargs
public final ModuleBuilder addTypeDefinitions(TypeDefinition<?>... elements)
```
    Adds elements to typeDefinitions set.
    
    Parameters:
    
    elements - An array of typeDefinitions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllTypeDefinitions
```
public final ModuleBuilder addAllTypeDefinitions(Iterable<? extends TypeDefinition<?>> elements)
```
    Adds elements to typeDefinitions set.
    
    Parameters:
    
    elements - An iterable of typeDefinitions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addGroupings
```
public final ModuleBuilder addGroupings(GroupingDefinition element)
```
    Adds one element to groupings set.
    
    Parameters:
    
    element - A groupings element
    
    Returns:
    
    this builder for use in a chained invocation
  - addGroupings
```
public final ModuleBuilder addGroupings(GroupingDefinition... elements)
```
    Adds elements to groupings set.
    
    Parameters:
    
    elements - An array of groupings elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllGroupings
```
public final ModuleBuilder addAllGroupings(Iterable<? extends GroupingDefinition> elements)
```
    Adds elements to groupings set.
    
    Parameters:
    
    elements - An iterable of groupings elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addUses
```
public final ModuleBuilder addUses(UsesNode element)
```
    Adds one element to uses set.
    
    Parameters:
    
    element - A uses element
    
    Returns:
    
    this builder for use in a chained invocation
  - addUses
```
public final ModuleBuilder addUses(UsesNode... elements)
```
    Adds elements to uses set.
    
    Parameters:
    
    elements - An array of uses elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllUses
```
public final ModuleBuilder addAllUses(Iterable<? extends UsesNode> elements)
```
    Adds elements to uses set.
    
    Parameters:
    
    elements - An iterable of uses elements
    
    Returns:
    
    this builder for use in a chained invocation
  - name
```
public final ModuleBuilder name(String name)
```
    Initializes the value for the name attribute.
    
    Parameters:
    
    name - The value for name
    
    Returns:
    
    this builder for use in a chained invocation
  - qNameModule
```
public final ModuleBuilder qNameModule(QNameModule qNameModule)
```
    Initializes the value for the qNameModule attribute.
    
    Parameters:
    
    qNameModule - The value for qNameModule
    
    Returns:
    
    this builder for use in a chained invocation
  - semanticVersion
```
public final ModuleBuilder semanticVersion(SemVer semanticVersion)
```
    Initializes the optional value semanticVersion to semanticVersion.
    
    Parameters:
    
    semanticVersion - The value for semanticVersion
    
    Returns:
    
    this builder for chained invocation
  - semanticVersion
```
public final ModuleBuilder semanticVersion(Optional<? extends SemVer> semanticVersion)
```
    Initializes the optional value semanticVersion to semanticVersion.
    
    Parameters:
    
    semanticVersion - The value for semanticVersion
    
    Returns:
    
    this builder for use in a chained invocation
  - prefix
```
public final ModuleBuilder prefix(String prefix)
```
    Initializes the value for the prefix attribute.
    
    Parameters:
    
    prefix - The value for prefix
    
    Returns:
    
    this builder for use in a chained invocation
  - yangVersion
```
public final ModuleBuilder yangVersion(YangVersion yangVersion)
```
    Initializes the value for the yangVersion attribute.
    
    Parameters:
    
    yangVersion - The value for yangVersion
    
    Returns:
    
    this builder for use in a chained invocation
  - organization
```
public final ModuleBuilder organization(String organization)
```
    Initializes the optional value organization to organization.
    
    Parameters:
    
    organization - The value for organization
    
    Returns:
    
    this builder for chained invocation
  - organization
```
public final ModuleBuilder organization(Optional<String> organization)
```
    Initializes the optional value organization to organization.
    
    Parameters:
    
    organization - The value for organization
    
    Returns:
    
    this builder for use in a chained invocation
  - contact
```
public final ModuleBuilder contact(String contact)
```
    Initializes the optional value contact to contact.
    
    Parameters:
    
    contact - The value for contact
    
    Returns:
    
    this builder for chained invocation
  - contact
```
public final ModuleBuilder contact(Optional<String> contact)
```
    Initializes the optional value contact to contact.
    
    Parameters:
    
    contact - The value for contact
    
    Returns:
    
    this builder for use in a chained invocation
  - addImports
```
public final ModuleBuilder addImports(ModuleImport element)
```
    Adds one element to imports set.
    
    Parameters:
    
    element - A imports element
    
    Returns:
    
    this builder for use in a chained invocation
  - addImports
```
public final ModuleBuilder addImports(ModuleImport... elements)
```
    Adds elements to imports set.
    
    Parameters:
    
    elements - An array of imports elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllImports
```
public final ModuleBuilder addAllImports(Iterable<? extends ModuleImport> elements)
```
    Adds elements to imports set.
    
    Parameters:
    
    elements - An iterable of imports elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addSubmodules
```
public final ModuleBuilder addSubmodules(Module element)
```
    Adds one element to submodules set.
    
    Parameters:
    
    element - A submodules element
    
    Returns:
    
    this builder for use in a chained invocation
  - addSubmodules
```
public final ModuleBuilder addSubmodules(Module... elements)
```
    Adds elements to submodules set.
    
    Parameters:
    
    elements - An array of submodules elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllSubmodules
```
public final ModuleBuilder addAllSubmodules(Iterable<? extends Module> elements)
```
    Adds elements to submodules set.
    
    Parameters:
    
    elements - An iterable of submodules elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addFeatures
```
public final ModuleBuilder addFeatures(FeatureDefinition element)
```
    Adds one element to features set.
    
    Parameters:
    
    element - A features element
    
    Returns:
    
    this builder for use in a chained invocation
  - addFeatures
```
public final ModuleBuilder addFeatures(FeatureDefinition... elements)
```
    Adds elements to features set.
    
    Parameters:
    
    elements - An array of features elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllFeatures
```
public final ModuleBuilder addAllFeatures(Iterable<? extends FeatureDefinition> elements)
```
    Adds elements to features set.
    
    Parameters:
    
    elements - An iterable of features elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAugmentations
```
public final ModuleBuilder addAugmentations(AugmentationSchemaNode element)
```
    Adds one element to augmentations set.
    
    Parameters:
    
    element - A augmentations element
    
    Returns:
    
    this builder for use in a chained invocation
  - addAugmentations
```
public final ModuleBuilder addAugmentations(AugmentationSchemaNode... elements)
```
    Adds elements to augmentations set.
    
    Parameters:
    
    elements - An array of augmentations elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllAugmentations
```
public final ModuleBuilder addAllAugmentations(Iterable<? extends AugmentationSchemaNode> elements)
```
    Adds elements to augmentations set.
    
    Parameters:
    
    elements - An iterable of augmentations elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addRpcs
```
public final ModuleBuilder addRpcs(RpcDefinition element)
```
    Adds one element to rpcs set.
    
    Parameters:
    
    element - A rpcs element
    
    Returns:
    
    this builder for use in a chained invocation
  - addRpcs
```
public final ModuleBuilder addRpcs(RpcDefinition... elements)
```
    Adds elements to rpcs set.
    
    Parameters:
    
    elements - An array of rpcs elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllRpcs
```
public final ModuleBuilder addAllRpcs(Iterable<? extends RpcDefinition> elements)
```
    Adds elements to rpcs set.
    
    Parameters:
    
    elements - An iterable of rpcs elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addDeviations
```
public final ModuleBuilder addDeviations(Deviation element)
```
    Adds one element to deviations set.
    
    Parameters:
    
    element - A deviations element
    
    Returns:
    
    this builder for use in a chained invocation
  - addDeviations
```
public final ModuleBuilder addDeviations(Deviation... elements)
```
    Adds elements to deviations set.
    
    Parameters:
    
    elements - An array of deviations elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllDeviations
```
public final ModuleBuilder addAllDeviations(Iterable<? extends Deviation> elements)
```
    Adds elements to deviations set.
    
    Parameters:
    
    elements - An iterable of deviations elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addIdentities
```
public final ModuleBuilder addIdentities(IdentitySchemaNode element)
```
    Adds one element to identities set.
    
    Parameters:
    
    element - A identities element
    
    Returns:
    
    this builder for use in a chained invocation
  - addIdentities
```
public final ModuleBuilder addIdentities(IdentitySchemaNode... elements)
```
    Adds elements to identities set.
    
    Parameters:
    
    elements - An array of identities elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllIdentities
```
public final ModuleBuilder addAllIdentities(Iterable<? extends IdentitySchemaNode> elements)
```
    Adds elements to identities set.
    
    Parameters:
    
    elements - An iterable of identities elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addExtensionSchemaNodes
```
public final ModuleBuilder addExtensionSchemaNodes(ExtensionDefinition element)
```
    Adds one element to extensionSchemaNodes list.
    
    Parameters:
    
    element - A extensionSchemaNodes element
    
    Returns:
    
    this builder for use in a chained invocation
  - addExtensionSchemaNodes
```
public final ModuleBuilder addExtensionSchemaNodes(ExtensionDefinition... elements)
```
    Adds elements to extensionSchemaNodes list.
    
    Parameters:
    
    elements - An array of extensionSchemaNodes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllExtensionSchemaNodes
```
public final ModuleBuilder addAllExtensionSchemaNodes(Iterable<? extends ExtensionDefinition> elements)
```
    Adds elements to extensionSchemaNodes list.
    
    Parameters:
    
    elements - An iterable of extensionSchemaNodes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - description
```
public final ModuleBuilder description(String description)
```
    Initializes the optional value description to description.
    
    Parameters:
    
    description - The value for description
    
    Returns:
    
    this builder for chained invocation
  - description
```
public final ModuleBuilder description(Optional<String> description)
```
    Initializes the optional value description to description.
    
    Parameters:
    
    description - The value for description
    
    Returns:
    
    this builder for use in a chained invocation
  - reference
```
public final ModuleBuilder reference(String reference)
```
    Initializes the optional value reference to reference.
    
    Parameters:
    
    reference - The value for reference
    
    Returns:
    
    this builder for chained invocation
  - reference
```
public final ModuleBuilder reference(Optional<String> reference)
```
    Initializes the optional value reference to reference.
    
    Parameters:
    
    reference - The value for reference
    
    Returns:
    
    this builder for use in a chained invocation
  - addNotifications
```
public final ModuleBuilder addNotifications(NotificationDefinition element)
```
    Adds one element to notifications set.
    
    Parameters:
    
    element - A notifications element
    
    Returns:
    
    this builder for use in a chained invocation
  - addNotifications
```
public final ModuleBuilder addNotifications(NotificationDefinition... elements)
```
    Adds elements to notifications set.
    
    Parameters:
    
    elements - An array of notifications elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllNotifications
```
public final ModuleBuilder addAllNotifications(Iterable<? extends NotificationDefinition> elements)
```
    Adds elements to notifications set.
    
    Parameters:
    
    elements - An iterable of notifications elements
    
    Returns:
    
    this builder for use in a chained invocation
  - build
```
public org.opendaylight.yangtools.yang.model.immutable.AbstractModule build()
```
    Builds a new AbstractModule.
    
    Returns:
    
    An immutable instance of Module
    
    Throws:
    
    IllegalStateException - if any required attributes are missing

Class ModuleBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModuleBuilder

Method Detail

putChildren

putChildren

putAllChildren

addTypeDefinitions

addTypeDefinitions

addAllTypeDefinitions

addGroupings

addGroupings

addAllGroupings

addUses

addUses

addAllUses

name

qNameModule

semanticVersion

semanticVersion

prefix

yangVersion

organization

organization

contact

contact

addImports

addImports

addAllImports

addSubmodules

addSubmodules

addAllSubmodules

addFeatures

addFeatures

addAllFeatures

addAugmentations

addAugmentations

addAllAugmentations

addRpcs

addRpcs

addAllRpcs

addDeviations

addDeviations

addAllDeviations

addIdentities

addIdentities

addAllIdentities

addExtensionSchemaNodes

addExtensionSchemaNodes

addAllExtensionSchemaNodes

description

description

reference

reference

addNotifications

addNotifications

addAllNotifications

build