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

Class NodeBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder
@Generated("mdsal-binding-generator") public class NodeBuilder extends Object
Class that builds Node 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: 

   
     Node createNode(int fooXyzzy, int barBaz) {
         return new NodeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of Node, 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

    • NodeBuilder

      public NodeBuilder()
      Construct an empty builder.

    • NodeBuilder

      public NodeBuilder(Node arg)
      Construct a new builder initialized from specified Node.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Node from which the builder should be initialized

    • NodeBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • key

      public NodeKey key()
      Return current value associated with the property corresponding to Node.key().
      Returns:
      current value

    • getId

      public NodeId getId()
      Return current value associated with the property corresponding to Node.getId().
      Returns:
      current value

    • getNodeConnector

      public Map<NodeConnectorKey,NodeConnector> getNodeConnector()
      Return current value associated with the property corresponding to Node.getNodeConnector().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Node>> 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

    • withKey

      public NodeBuilder withKey(NodeKey key)
      Set the key value corresponding to Node.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setId

      public NodeBuilder setId(NodeId value)
      Set the property corresponding to Node.getId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNodeConnector

      public NodeBuilder setNodeConnector(Map<NodeConnectorKey,NodeConnector> values)
      Set the property corresponding to Node.getNodeConnector() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

      public NodeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Node> 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 NodeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Node>> 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 Node build()
      A new Node instance.
      Returns:
      A new Node instance.