Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.l3vpn.ipv4.multicast.group

Class L3vpnIpv4MulticastBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.l3vpn.ipv4.multicast.group.L3vpnIpv4MulticastBuilder
@Generated("mdsal-binding-generator") public class L3vpnIpv4MulticastBuilder extends Object
Class that builds L3vpnIpv4Multicast 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: 

   
     L3vpnIpv4Multicast createL3vpnIpv4Multicast(int fooXyzzy, int barBaz) {
         return new L3vpnIpv4MulticastBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • L3vpnIpv4MulticastBuilder

      public L3vpnIpv4MulticastBuilder()
      Construct an empty builder.

    • L3vpnIpv4MulticastBuilder

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

    • L3vpnIpv4MulticastBuilder

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

    • L3vpnIpv4MulticastBuilder

      public L3vpnIpv4MulticastBuilder(L3vpnIpv4Multicast base)
      Construct a builder initialized with state from specified L3vpnIpv4Multicast.
      Parameters:
      base - L3vpnIpv4Multicast 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 L3vpnIpv4Multicast empty()
      Get empty instance of L3vpnIpv4Multicast.
      Returns:
      An empty L3vpnIpv4Multicast

    • 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<L3vpnIpv4Multicast>> 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 L3vpnIpv4MulticastBuilder setPrefixLimit(PrefixLimit value)
      Set the property corresponding to AllAfiSafiCommon.getPrefixLimit() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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