ListSchemaNodeBuilder (yangtools 3.0.0-SNAPSHOT API)

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

```
@NotThreadSafe
public final class ListSchemaNodeBuilder
extends Object
```
Builds instances of type AbstractListSchemaNode. Initialize attributes and then invoke the build() method to create an immutable instance.
ListSchemaNodeBuilder 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

ListSchemaNodeBuilder()
Creates a builder for AbstractListSchemaNode instances.

Constructors
Constructor and Description
`ListSchemaNodeBuilder()` Creates a builder for `AbstractListSchemaNode` instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListSchemaNodeBuilder`	`addActions(ActionDefinition... elements)` Adds elements to `actions` set.
`ListSchemaNodeBuilder`	`addActions(ActionDefinition element)` Adds one element to `actions` set.
`ListSchemaNodeBuilder`	`addAllActions(Iterable<? extends ActionDefinition> elements)` Adds elements to `actions` set.
`ListSchemaNodeBuilder`	`addAllAvailableAugmentations(Iterable<? extends AugmentationSchemaNode> elements)` Adds elements to `availableAugmentations` set.
`ListSchemaNodeBuilder`	`addAllGroupings(Iterable<? extends GroupingDefinition> elements)` Adds elements to `groupings` set.
`ListSchemaNodeBuilder`	`addAllKeyDefinition(Iterable<? extends QName> elements)` Adds elements to `keyDefinition` list.
`ListSchemaNodeBuilder`	`addAllNotifications(Iterable<? extends NotificationDefinition> elements)` Adds elements to `notifications` set.
`ListSchemaNodeBuilder`	`addAllTypeDefinitions(Iterable<? extends TypeDefinition<?>> elements)` Adds elements to `typeDefinitions` set.
`ListSchemaNodeBuilder`	`addAllUses(Iterable<? extends UsesNode> elements)` Adds elements to `uses` set.
`ListSchemaNodeBuilder`	`addAvailableAugmentations(AugmentationSchemaNode... elements)` Adds elements to `availableAugmentations` set.
`ListSchemaNodeBuilder`	`addAvailableAugmentations(AugmentationSchemaNode element)` Adds one element to `availableAugmentations` set.
`ListSchemaNodeBuilder`	`addGroupings(GroupingDefinition... elements)` Adds elements to `groupings` set.
`ListSchemaNodeBuilder`	`addGroupings(GroupingDefinition element)` Adds one element to `groupings` set.
`ListSchemaNodeBuilder`	`addKeyDefinition(QName... elements)` Adds elements to `keyDefinition` list.
`ListSchemaNodeBuilder`	`addKeyDefinition(QName element)` Adds one element to `keyDefinition` list.
`ListSchemaNodeBuilder`	`addNotifications(NotificationDefinition... elements)` Adds elements to `notifications` set.
`ListSchemaNodeBuilder`	`addNotifications(NotificationDefinition element)` Adds one element to `notifications` set.
`ListSchemaNodeBuilder`	`addTypeDefinitions(TypeDefinition<?>... elements)` Adds elements to `typeDefinitions` set.
`ListSchemaNodeBuilder`	`addTypeDefinitions(TypeDefinition<?> element)` Adds one element to `typeDefinitions` set.
`ListSchemaNodeBuilder`	`addUses(UsesNode... elements)` Adds elements to `uses` set.
`ListSchemaNodeBuilder`	`addUses(UsesNode element)` Adds one element to `uses` set.
`org.opendaylight.yangtools.yang.model.immutable.AbstractListSchemaNode`	`build()` Builds a new `AbstractListSchemaNode`.
`ListSchemaNodeBuilder`	`description(Optional<String> description)` Initializes the optional value `description` to description.
`ListSchemaNodeBuilder`	`description(String description)` Initializes the optional value `description` to description.
`ListSchemaNodeBuilder`	`elementCountConstraint(ElementCountConstraint elementCountConstraint)` Initializes the optional value `elementCountConstraint` to elementCountConstraint.
`ListSchemaNodeBuilder`	`elementCountConstraint(Optional<? extends ElementCountConstraint> elementCountConstraint)` Initializes the optional value `elementCountConstraint` to elementCountConstraint.
`ListSchemaNodeBuilder`	`isAddedByUses(boolean isAddedByUses)` Initializes the value for the `isAddedByUses` attribute.
`ListSchemaNodeBuilder`	`isAugmenting(boolean isAugmenting)` Initializes the value for the `isAugmenting` attribute.
`ListSchemaNodeBuilder`	`isConfiguration(boolean isConfiguration)` Initializes the value for the `isConfiguration` attribute.
`ListSchemaNodeBuilder`	`isUserOrdered(boolean isUserOrdered)` Initializes the value for the `isUserOrdered` attribute.
`ListSchemaNodeBuilder`	`mustConstraints(Collection<MustDefinition> mustConstraints)` Initializes the value for the `mustConstraints` attribute.
`ListSchemaNodeBuilder`	`path(SchemaPath path)` Initializes the value for the `path` attribute.
`ListSchemaNodeBuilder`	`putAllChildren(Map<? extends QName,? extends DataSchemaNode> entries)` Put all mappings from the specified map as entries to `children` map.
`ListSchemaNodeBuilder`	`putChildren(Map.Entry<? extends QName,? extends DataSchemaNode> entry)` Put one entry to the `children` map.
`ListSchemaNodeBuilder`	`putChildren(QName key, DataSchemaNode value)` Put one entry to the `children` map.
`ListSchemaNodeBuilder`	`qName(QName qName)` Initializes the value for the `qName` attribute.
`ListSchemaNodeBuilder`	`reference(Optional<String> reference)` Initializes the optional value `reference` to reference.
`ListSchemaNodeBuilder`	`reference(String reference)` Initializes the optional value `reference` to reference.
`ListSchemaNodeBuilder`	`status(Status status)` Initializes the value for the `status` attribute.
`ListSchemaNodeBuilder`	`uniqueConstraints(Collection<UniqueConstraint> uniqueConstraints)` Initializes the value for the `uniqueConstraints` attribute.
`ListSchemaNodeBuilder`	`whenCondition(Optional<? extends RevisionAwareXPath> whenCondition)` Initializes the optional value `whenCondition` to whenCondition.
`ListSchemaNodeBuilder`	`whenCondition(RevisionAwareXPath whenCondition)` Initializes the optional value `whenCondition` to whenCondition.

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

- Constructor Detail
  - ListSchemaNodeBuilder
```
public ListSchemaNodeBuilder()
```
    Creates a builder for AbstractListSchemaNode instances.
- Method Detail
  - putChildren
```
public final ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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
  - addKeyDefinition
```
public final ListSchemaNodeBuilder addKeyDefinition(QName element)
```
    Adds one element to keyDefinition list.
    
    Parameters:
    
    element - A keyDefinition element
    
    Returns:
    
    this builder for use in a chained invocation
  - addKeyDefinition
```
public final ListSchemaNodeBuilder addKeyDefinition(QName... elements)
```
    Adds elements to keyDefinition list.
    
    Parameters:
    
    elements - An array of keyDefinition elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllKeyDefinition
```
public final ListSchemaNodeBuilder addAllKeyDefinition(Iterable<? extends QName> elements)
```
    Adds elements to keyDefinition list.
    
    Parameters:
    
    elements - An iterable of keyDefinition elements
    
    Returns:
    
    this builder for use in a chained invocation
  - isUserOrdered
```
public final ListSchemaNodeBuilder isUserOrdered(boolean isUserOrdered)
```
    Initializes the value for the isUserOrdered attribute.
    
    Parameters:
    
    isUserOrdered - The value for isUserOrdered
    
    Returns:
    
    this builder for use in a chained invocation
  - uniqueConstraints
```
public final ListSchemaNodeBuilder uniqueConstraints(Collection<UniqueConstraint> uniqueConstraints)
```
    Initializes the value for the uniqueConstraints attribute.
    
    Parameters:
    
    uniqueConstraints - The value for uniqueConstraints
    
    Returns:
    
    this builder for use in a chained invocation
  - addAvailableAugmentations
```
public final ListSchemaNodeBuilder addAvailableAugmentations(AugmentationSchemaNode element)
```
    Adds one element to availableAugmentations set.
    
    Parameters:
    
    element - A availableAugmentations element
    
    Returns:
    
    this builder for use in a chained invocation
  - addAvailableAugmentations
```
public final ListSchemaNodeBuilder addAvailableAugmentations(AugmentationSchemaNode... elements)
```
    Adds elements to availableAugmentations set.
    
    Parameters:
    
    elements - An array of availableAugmentations elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllAvailableAugmentations
```
public final ListSchemaNodeBuilder addAllAvailableAugmentations(Iterable<? extends AugmentationSchemaNode> elements)
```
    Adds elements to availableAugmentations set.
    
    Parameters:
    
    elements - An iterable of availableAugmentations elements
    
    Returns:
    
    this builder for use in a chained invocation
  - isConfiguration
```
public final ListSchemaNodeBuilder isConfiguration(boolean isConfiguration)
```
    Initializes the value for the isConfiguration attribute.
    
    Parameters:
    
    isConfiguration - The value for isConfiguration
    
    Returns:
    
    this builder for use in a chained invocation
  - qName
```
public final ListSchemaNodeBuilder qName(QName qName)
```
    Initializes the value for the qName attribute.
    
    Parameters:
    
    qName - The value for qName
    
    Returns:
    
    this builder for use in a chained invocation
  - path
```
public final ListSchemaNodeBuilder path(SchemaPath path)
```
    Initializes the value for the path attribute.
    
    Parameters:
    
    path - The value for path
    
    Returns:
    
    this builder for use in a chained invocation
  - status
```
public final ListSchemaNodeBuilder status(Status status)
```
    Initializes the value for the status attribute.
    
    Parameters:
    
    status - The value for status
    
    Returns:
    
    this builder for use in a chained invocation
  - description
```
public final ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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
  - isAugmenting
```
public final ListSchemaNodeBuilder isAugmenting(boolean isAugmenting)
```
    Initializes the value for the isAugmenting attribute.
    
    Parameters:
    
    isAugmenting - The value for isAugmenting
    
    Returns:
    
    this builder for use in a chained invocation
  - isAddedByUses
```
public final ListSchemaNodeBuilder isAddedByUses(boolean isAddedByUses)
```
    Initializes the value for the isAddedByUses attribute.
    
    Parameters:
    
    isAddedByUses - The value for isAddedByUses
    
    Returns:
    
    this builder for use in a chained invocation
  - whenCondition
```
public final ListSchemaNodeBuilder whenCondition(RevisionAwareXPath whenCondition)
```
    Initializes the optional value whenCondition to whenCondition.
    
    Parameters:
    
    whenCondition - The value for whenCondition
    
    Returns:
    
    this builder for chained invocation
  - whenCondition
```
public final ListSchemaNodeBuilder whenCondition(Optional<? extends RevisionAwareXPath> whenCondition)
```
    Initializes the optional value whenCondition to whenCondition.
    
    Parameters:
    
    whenCondition - The value for whenCondition
    
    Returns:
    
    this builder for use in a chained invocation
  - addNotifications
```
public final ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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 ListSchemaNodeBuilder 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
  - addActions
```
public final ListSchemaNodeBuilder addActions(ActionDefinition element)
```
    Adds one element to actions set.
    
    Parameters:
    
    element - A actions element
    
    Returns:
    
    this builder for use in a chained invocation
  - addActions
```
public final ListSchemaNodeBuilder addActions(ActionDefinition... elements)
```
    Adds elements to actions set.
    
    Parameters:
    
    elements - An array of actions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllActions
```
public final ListSchemaNodeBuilder addAllActions(Iterable<? extends ActionDefinition> elements)
```
    Adds elements to actions set.
    
    Parameters:
    
    elements - An iterable of actions elements
    
    Returns:
    
    this builder for use in a chained invocation
  - elementCountConstraint
```
public final ListSchemaNodeBuilder elementCountConstraint(ElementCountConstraint elementCountConstraint)
```
    Initializes the optional value elementCountConstraint to elementCountConstraint.
    
    Parameters:
    
    elementCountConstraint - The value for elementCountConstraint
    
    Returns:
    
    this builder for chained invocation
  - elementCountConstraint
```
public final ListSchemaNodeBuilder elementCountConstraint(Optional<? extends ElementCountConstraint> elementCountConstraint)
```
    Initializes the optional value elementCountConstraint to elementCountConstraint.
    
    Parameters:
    
    elementCountConstraint - The value for elementCountConstraint
    
    Returns:
    
    this builder for use in a chained invocation
  - mustConstraints
```
public final ListSchemaNodeBuilder mustConstraints(Collection<MustDefinition> mustConstraints)
```
    Initializes the value for the mustConstraints attribute.
    
    Parameters:
    
    mustConstraints - The value for mustConstraints
    
    Returns:
    
    this builder for use in a chained invocation
  - build
```
public org.opendaylight.yangtools.yang.model.immutable.AbstractListSchemaNode build()
```
    Builds a new AbstractListSchemaNode.
    
    Returns:
    
    An immutable instance of ListSchemaNode
    
    Throws:
    
    IllegalStateException - if any required attributes are missing

Class ListSchemaNodeBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListSchemaNodeBuilder

Method Detail

putChildren

putChildren

putAllChildren

addTypeDefinitions

addTypeDefinitions

addAllTypeDefinitions

addGroupings

addGroupings

addAllGroupings

addUses

addUses

addAllUses

addKeyDefinition

addKeyDefinition

addAllKeyDefinition

isUserOrdered

uniqueConstraints

addAvailableAugmentations

addAvailableAugmentations

addAllAvailableAugmentations

isConfiguration

qName

path

status

description

description

reference

reference

isAugmenting

isAddedByUses

whenCondition

whenCondition

addNotifications

addNotifications

addAllNotifications

addActions

addActions

addAllActions

elementCountConstraint

elementCountConstraint

mustConstraints

build