Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.es.route

Class EsRouteBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.es.route.EsRouteBuilder
@Generated("mdsal-binding-generator") public class EsRouteBuilder extends Object
Class that builds EsRoute 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: 

   
     EsRoute createEsRoute(int fooXyzzy, int barBaz) {
         return new EsRouteBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • EsRouteBuilder

      public EsRouteBuilder()
      Construct an empty builder.

    • EsRouteBuilder

      public EsRouteBuilder(Esi arg)
      Construct a new builder initialized from specified Esi.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.Esi from which the builder should be initialized

    • EsRouteBuilder

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

    • EsRouteBuilder

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

    • getEsi

      public Esi getEsi()
      Return current value associated with the property corresponding to Esi.getEsi().
      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

    • augmentation

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

    • setEsi

      public EsRouteBuilder setEsi(Esi value)
      Set the property corresponding to Esi.getEsi() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOrigRouteIp

      public EsRouteBuilder 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

    • addAugmentation

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