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

Class InterAsIPmsiADBuilder

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

   
     InterAsIPmsiAD createInterAsIPmsiAD(int fooXyzzy, int barBaz) {
         return new InterAsIPmsiADBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • InterAsIPmsiADBuilder

      public InterAsIPmsiADBuilder()
      Construct an empty builder.

    • InterAsIPmsiADBuilder

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

    • InterAsIPmsiADBuilder

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

    • InterAsIPmsiADBuilder

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

    • getRouteDistinguisher

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

    • getSourceAs

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

    • augmentation

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

    • setRouteDistinguisher

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

    • setSourceAs

      public InterAsIPmsiADBuilder setSourceAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
      Set the property corresponding to SourceAsGrouping.getSourceAs() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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