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

Class VpnDestinationBuilder

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

   
     VpnDestination createVpnDestination(int fooXyzzy, int barBaz) {
         return new VpnDestinationBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • VpnDestinationBuilder

      public VpnDestinationBuilder()
      Construct an empty builder.

    • VpnDestinationBuilder

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

    • VpnDestinationBuilder

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

    • VpnDestinationBuilder

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

    • VpnDestinationBuilder

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

    • VpnDestinationBuilder

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

    • getLabelStack

      public List<LabelStack> getLabelStack()
      Return current value associated with the property corresponding to LabeledUnicast.getLabelStack().
      Returns:
      current value

    • getPathId

      public PathId getPathId()
      Return current value associated with the property corresponding to PathIdGrouping.getPathId().
      Returns:
      current value

    • getPrefix

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
      Return current value associated with the property corresponding to LabeledUnicast.getPrefix().
      Returns:
      current value

    • getRouteDistinguisher

      public RouteDistinguisher getRouteDistinguisher()
      Return current value associated with the property corresponding to RouteDistinguisherGrouping.getRouteDistinguisher().
      Returns:
      current value

    • augmentation

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

    • setLabelStack

      public VpnDestinationBuilder setLabelStack(List<LabelStack> values)
      Set the property corresponding to LabeledUnicast.getLabelStack() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setPathId

      public VpnDestinationBuilder setPathId(PathId value)
      Set the property corresponding to PathIdGrouping.getPathId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPrefix

      public VpnDestinationBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
      Set the property corresponding to LabeledUnicast.getPrefix() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRouteDistinguisher

      public VpnDestinationBuilder setRouteDistinguisher(RouteDistinguisher value)
      Set the property corresponding to RouteDistinguisherGrouping.getRouteDistinguisher() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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