Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.isis.topology.rev131021.isis.node.attributes.isis.node.attributes.router.type

Class Level2Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.isis.topology.rev131021.isis.node.attributes.isis.node.attributes.router.type.Level2Builder
@Generated("mdsal-binding-generator") public class Level2Builder extends Object
Class that builds Level2 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: 

   
     Level2 createLevel2(int fooXyzzy, int barBaz) {
         return new Level2Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Level2Builder

      public Level2Builder()
      Construct an empty builder.

    • Level2Builder

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

  • Method Details

    • getLevel2

      public org.opendaylight.yangtools.yang.common.Empty getLevel2()
      Return current value associated with the property corresponding to Level2.getLevel2().
      Returns:
      current value

    • augmentation

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

    • setLevel2

      public Level2Builder setLevel2(org.opendaylight.yangtools.yang.common.Empty value)
      Set the property corresponding to Level2.getLevel2() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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