@Generated("mdsal-binding-generator") public class Ipv6PrefixSidCaseBuilder extends Object
Class that builds Ipv6PrefixSidCase 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:

     Ipv6PrefixSidCase createIpv6PrefixSidCase(int fooXyzzy, int barBaz) {
         return new Ipv6PrefixSidCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())

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

    • Ipv6PrefixSidCaseBuilder

      public Ipv6PrefixSidCaseBuilder()
      Construct an empty builder.
    • Ipv6PrefixSidCaseBuilder

      public Ipv6PrefixSidCaseBuilder(Ipv6PrefixSidCase base)
      Construct a builder initialized with state from specified Ipv6PrefixSidCase.
      base - Ipv6PrefixSidCase from which the builder should be initialized
  • Method Details

    • getIpv6PrefixSid

      public Ipv6PrefixSid getIpv6PrefixSid()
      Return current value associated with the property corresponding to Ipv6PrefixSidCase.getIpv6PrefixSid().
      current value
    • augmentation

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

      public Ipv6PrefixSidCaseBuilder setIpv6PrefixSid(Ipv6PrefixSid value)
      Set the property corresponding to Ipv6PrefixSidCase.getIpv6PrefixSid() to the specified value.
      value - desired value
      this builder
    • addAugmentation

      public Ipv6PrefixSidCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixSidCase> augmentation)
      Add an augmentation to this builder's product.
      augmentation - augmentation to be added
      this builder
      NullPointerException - if augmentation is null
    • removeAugmentation

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

      public @NonNull Ipv6PrefixSidCase build()
      A new Ipv6PrefixSidCase instance.
      A new Ipv6PrefixSidCase instance.