Package org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819

Class NodesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder
@Generated("mdsal-binding-generator") public class NodesBuilder extends Object
Class that builds Nodes instances. Overall design of the class is that of a fluent interface, where method chaining is used.

In general, this class is supposed to be used like this template: 

   
     Nodes createNodes(int fooXyzzy, int barBaz) {
         return new NodesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of Nodes, as instances can be freely passed around without worrying about synchronization issues.

As a side note: method chaining results in:

  • very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is on the stack, so further method invocations just need to fill method arguments for the next method invocation, which is terminated by build(), which is then returned from the method
  • better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
  • better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
See Also:

  • Constructor Details

    • NodesBuilder

      public NodesBuilder()
      Construct an empty builder.

    • NodesBuilder

      public NodesBuilder(Nodes base)
      Construct a builder initialized with state from specified Nodes.
      Parameters:
      base - Nodes from which the builder should be initialized

  • Method Details

    • empty

      public static @NonNull Nodes empty()
      Get empty instance of Nodes.
      Returns:
      An empty Nodes

    • getNode

      public Map<NodeKey,Node> getNode()
      Return current value associated with the property corresponding to Nodes.getNode().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Nodes>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      Parameters:
      augmentationType - augmentation type class
      Returns:
      Augmentation object from this builder, or null if not present
      Throws:
      NullPointerException - if augmentType is null

    • setNode

      public NodesBuilder setNode(Map<NodeKey,Node> values)
      Set the property corresponding to Nodes.getNode() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

      public NodesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Nodes> augmentation)
      Add an augmentation to this builder's product.
      Parameters:
      augmentation - augmentation to be added
      Returns:
      this builder
      Throws:
      NullPointerException - if augmentation is null

    • removeAugmentation

      public NodesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Nodes>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      Parameters:
      augmentationType - augmentation type to be removed
      Returns:
      this builder

    • build

      public @NonNull Nodes build()
      A new Nodes instance.
      Returns:
      A new Nodes instance.