Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.non.branch.node.object

Class NonBranchNodeListBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.non.branch.node.object.NonBranchNodeListBuilder
@Generated("mdsal-binding-generator") public class NonBranchNodeListBuilder extends Object
Class that builds NonBranchNodeList 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: 

   
     NonBranchNodeList createNonBranchNodeList(int fooXyzzy, int barBaz) {
         return new NonBranchNodeListBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NonBranchNodeListBuilder

      public NonBranchNodeListBuilder()
      Construct an empty builder.

    • NonBranchNodeListBuilder

      public NonBranchNodeListBuilder(Bnc arg)
      Construct a new builder initialized from specified Bnc.
      Parameters:
      arg - Bnc from which the builder should be initialized

    • NonBranchNodeListBuilder

      public NonBranchNodeListBuilder(ObjectHeader arg)
      Construct a new builder initialized from specified ObjectHeader.
      Parameters:
      arg - ObjectHeader from which the builder should be initialized

    • NonBranchNodeListBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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

    • empty

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

    • getIgnore

      public Boolean getIgnore()
      Return current value associated with the property corresponding to ObjectHeader.getIgnore().
      Returns:
      current value

    • getProcessingRule

      public Boolean getProcessingRule()
      Return current value associated with the property corresponding to ObjectHeader.getProcessingRule().
      Returns:
      current value

    • getSubobject

      public List<Subobject> getSubobject()
      Return current value associated with the property corresponding to Bnc.getSubobject().
      Returns:
      current value

    • augmentation

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

    • setIgnore

      public NonBranchNodeListBuilder setIgnore(Boolean value)
      Set the property corresponding to ObjectHeader.getIgnore() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setProcessingRule

      public NonBranchNodeListBuilder setProcessingRule(Boolean value)
      Set the property corresponding to ObjectHeader.getProcessingRule() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSubobject

      public NonBranchNodeListBuilder setSubobject(List<Subobject> values)
      Set the property corresponding to Bnc.getSubobject() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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