Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.ipv6.rev180329.application.rib.tables.routes

Class RoutesVpnIpv6CaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.ipv6.rev180329.application.rib.tables.routes.RoutesVpnIpv6CaseBuilder
@Generated("mdsal-binding-generator") public class RoutesVpnIpv6CaseBuilder extends Object
Class that builds RoutesVpnIpv6Case 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: 

   
     RoutesVpnIpv6Case createRoutesVpnIpv6Case(int fooXyzzy, int barBaz) {
         return new RoutesVpnIpv6CaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • RoutesVpnIpv6CaseBuilder

      public RoutesVpnIpv6CaseBuilder()
      Construct an empty builder.

    • RoutesVpnIpv6CaseBuilder

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

    • RoutesVpnIpv6CaseBuilder

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

    • getVpnIpv6Routes

      public VpnIpv6Routes getVpnIpv6Routes()
      Return current value associated with the property corresponding to L3vpnIpv6Routes.getVpnIpv6Routes().
      Returns:
      current value

    • augmentation

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

    • setVpnIpv6Routes

      public RoutesVpnIpv6CaseBuilder setVpnIpv6Routes(VpnIpv6Routes value)
      Set the property corresponding to L3vpnIpv6Routes.getVpnIpv6Routes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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