Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes

Class Ipv4RouteBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4RouteBuilder
@Generated("mdsal-binding-generator") public class Ipv4RouteBuilder extends Object
Class that builds Ipv4Route 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: 

   
     Ipv4Route createIpv4Route(int fooXyzzy, int barBaz) {
         return new Ipv4RouteBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv4RouteBuilder

      public Ipv4RouteBuilder()
      Construct an empty builder.

    • Ipv4RouteBuilder

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

    • Ipv4RouteBuilder

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

    • Ipv4RouteBuilder

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

    • Ipv4RouteBuilder

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

    • key

      public Ipv4RouteKey key()
      Return current value associated with the property corresponding to Ipv4Route.key().
      Returns:
      current value

    • getAttributes

      public Attributes getAttributes()
      Return current value associated with the property corresponding to PathAttributes.getAttributes().
      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.Ipv4Prefix getPrefix()
      Return current value associated with the property corresponding to Ipv4Route.getPrefix().
      Returns:
      current value

    • getRouteKey

      public String getRouteKey()
      Return current value associated with the property corresponding to Route.getRouteKey().
      Returns:
      current value

    • augmentation

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

    • withKey

      public Ipv4RouteBuilder withKey(Ipv4RouteKey key)
      Set the key value corresponding to Ipv4Route.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setAttributes

      public Ipv4RouteBuilder setAttributes(Attributes value)
      Set the property corresponding to PathAttributes.getAttributes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPathId

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

    • setPrefix

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

    • setRouteKey

      public Ipv4RouteBuilder setRouteKey(String value)
      Set the property corresponding to Route.getRouteKey() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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