Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324.path.constraints

Class IncludeRouteBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324.path.constraints.IncludeRouteBuilder
@Generated("mdsal-binding-generator") public class IncludeRouteBuilder extends Object
Class that builds IncludeRoute 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: 

   
     IncludeRoute createIncludeRoute(int fooXyzzy, int barBaz) {
         return new IncludeRouteBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • IncludeRouteBuilder

      public IncludeRouteBuilder()
      Construct an empty builder.

    • IncludeRouteBuilder

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

  • Method Details

    • getIpv4

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

    • getIpv6

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

    • augmentation

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

    • setIpv4

      public IncludeRouteBuilder setIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
      Set the property corresponding to IncludeRoute.getIpv4() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpv6

      public IncludeRouteBuilder setIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
      Set the property corresponding to IncludeRoute.getIpv6() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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