java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.redirect.ipv6.extended.community.RedirectIpv6Builder

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

   
     RedirectIpv6 createRedirectIpv6(int fooXyzzy, int barBaz) {
         return new RedirectIpv6Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • RedirectIpv6Builder

      public RedirectIpv6Builder()
      Construct an empty builder.
    • RedirectIpv6Builder

      public RedirectIpv6Builder(RedirectIpv6 base)
      Construct a builder initialized with state from specified RedirectIpv6.
      Parameters:
      base - RedirectIpv6 from which the builder should be initialized
  • Method Details

    • empty

      public static @NonNull RedirectIpv6 empty()
      Get empty instance of RedirectIpv6.
      Returns:
      An empty RedirectIpv6
    • getGlobalAdministrator

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone getGlobalAdministrator()
      Return current value associated with the property corresponding to RedirectIpv6.getGlobalAdministrator().
      Returns:
      current value
    • getLocalAdministrator

      public org.opendaylight.yangtools.yang.common.Uint16 getLocalAdministrator()
      Return current value associated with the property corresponding to RedirectIpv6.getLocalAdministrator().
      Returns:
      current value
    • augmentation

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

      public RedirectIpv6Builder setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)
      Set the property corresponding to RedirectIpv6.getGlobalAdministrator() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setLocalAdministrator

      public RedirectIpv6Builder setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to RedirectIpv6.getLocalAdministrator() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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