Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.ipv4.rev180329.l3vpn.ipv4.destination

Class VpnIpv4DestinationBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.ipv4.rev180329.l3vpn.ipv4.destination.VpnIpv4DestinationBuilder
@Generated("mdsal-binding-generator") public class VpnIpv4DestinationBuilder extends Object
Class that builds VpnIpv4Destination 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: 

   
     VpnIpv4Destination createVpnIpv4Destination(int fooXyzzy, int barBaz) {
         return new VpnIpv4DestinationBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • VpnIpv4DestinationBuilder

      public VpnIpv4DestinationBuilder()
      Construct an empty builder.

    • VpnIpv4DestinationBuilder

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

    • VpnIpv4DestinationBuilder

      public VpnIpv4DestinationBuilder(VpnIpv4Destination base)
      Construct a builder initialized with state from specified VpnIpv4Destination.
      Parameters:
      base - VpnIpv4Destination from which the builder should be initialized

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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 VpnIpv4Destination empty()
      Get empty instance of VpnIpv4Destination.
      Returns:
      An empty VpnIpv4Destination

    • getVpnDestination

      public List<VpnDestination> getVpnDestination()
      Return current value associated with the property corresponding to L3vpnIpDestinationType.getVpnDestination().
      Returns:
      current value

    • augmentation

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

    • setVpnDestination

      public VpnIpv4DestinationBuilder setVpnDestination(List<VpnDestination> values)
      Set the property corresponding to L3vpnIpDestinationType.getVpnDestination() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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