Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community

Class RouteOriginIpv4CaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.RouteOriginIpv4CaseBuilder
@Generated("mdsal-binding-generator") public class RouteOriginIpv4CaseBuilder extends Object
Class that builds RouteOriginIpv4Case 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: 

   
     RouteOriginIpv4Case createRouteOriginIpv4Case(int fooXyzzy, int barBaz) {
         return new RouteOriginIpv4CaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • RouteOriginIpv4CaseBuilder

      public RouteOriginIpv4CaseBuilder()
      Construct an empty builder.

    • RouteOriginIpv4CaseBuilder

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

  • Method Details

    • getRouteOriginIpv4

      public RouteOriginIpv4 getRouteOriginIpv4()
      Return current value associated with the property corresponding to RouteOriginIpv4Case.getRouteOriginIpv4().
      Returns:
      current value

    • augmentation

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

    • setRouteOriginIpv4

      public RouteOriginIpv4CaseBuilder setRouteOriginIpv4(RouteOriginIpv4 value)
      Set the property corresponding to RouteOriginIpv4Case.getRouteOriginIpv4() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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