Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.s.pmsi.a.d.grouping

Class SPmsiADBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.s.pmsi.a.d.grouping.SPmsiADBuilder
@Generated("mdsal-binding-generator") public class SPmsiADBuilder extends Object
Class that builds SPmsiAD 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: 

   
     SPmsiAD createSPmsiAD(int fooXyzzy, int barBaz) {
         return new SPmsiADBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SPmsiADBuilder

      public SPmsiADBuilder()
      Construct an empty builder.

    • SPmsiADBuilder

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

    • SPmsiADBuilder

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

    • SPmsiADBuilder

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

    • SPmsiADBuilder

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

    • SPmsiADBuilder

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

    • getMulticastGroup

      public MulticastGroup getMulticastGroup()
      Return current value associated with the property corresponding to MulticastGroupOpaqueGrouping.getMulticastGroup().
      Returns:
      current value

    • getMulticastSource

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

    • getOrigRouteIp

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getOrigRouteIp()
      Return current value associated with the property corresponding to OrigRouteIpGrouping.getOrigRouteIp().
      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<SPmsiAD>> 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

    • setMulticastGroup

      public SPmsiADBuilder setMulticastGroup(MulticastGroup value)
      Set the property corresponding to MulticastGroupOpaqueGrouping.getMulticastGroup() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMulticastSource

      public SPmsiADBuilder setMulticastSource(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
      Set the property corresponding to MulticastSourceRdGrouping.getMulticastSource() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOrigRouteIp

      public SPmsiADBuilder setOrigRouteIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
      Set the property corresponding to OrigRouteIpGrouping.getOrigRouteIp() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRouteDistinguisher

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

    • addAugmentation

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