Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.ipv6.labelled.unicast.group

Class Ipv6LabelledUnicastBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.ipv6.labelled.unicast.group.Ipv6LabelledUnicastBuilder
@Generated("mdsal-binding-generator") public class Ipv6LabelledUnicastBuilder extends Object
Class that builds Ipv6LabelledUnicast 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: 

   
     Ipv6LabelledUnicast createIpv6LabelledUnicast(int fooXyzzy, int barBaz) {
         return new Ipv6LabelledUnicastBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv6LabelledUnicastBuilder

      public Ipv6LabelledUnicastBuilder()
      Construct an empty builder.

    • Ipv6LabelledUnicastBuilder

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

    • Ipv6LabelledUnicastBuilder

      public Ipv6LabelledUnicastBuilder(Ipv6LabelledUnicast base)
      Construct a builder initialized with state from specified Ipv6LabelledUnicast.
      Parameters:
      base - Ipv6LabelledUnicast 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

    • empty

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

    • getPrefixLimit

      public PrefixLimit getPrefixLimit()
      Return current value associated with the property corresponding to AllAfiSafiCommon.getPrefixLimit().
      Returns:
      current value

    • augmentation

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

    • setPrefixLimit

      public Ipv6LabelledUnicastBuilder setPrefixLimit(PrefixLimit value)
      Set the property corresponding to AllAfiSafiCommon.getPrefixLimit() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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