Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.segment.computation.p2p

Class ReportedRouteBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.segment.computation.p2p.ReportedRouteBuilder
@Generated("mdsal-binding-generator") public class ReportedRouteBuilder extends Object
Class that builds ReportedRoute 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: 

   
     ReportedRoute createReportedRoute(int fooXyzzy, int barBaz) {
         return new ReportedRouteBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ReportedRouteBuilder

      public ReportedRouteBuilder()
      Construct an empty builder.

    • ReportedRouteBuilder

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

    • ReportedRouteBuilder

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

    • ReportedRouteBuilder

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

    • getReoptimizationBandwidth

      public ReoptimizationBandwidth getReoptimizationBandwidth()
      Return current value associated with the property corresponding to ReoptimizationBandwidthObject.getReoptimizationBandwidth().
      Returns:
      current value

    • getRro

      public Rro getRro()
      Return current value associated with the property corresponding to ReportedRouteObject.getRro().
      Returns:
      current value

    • augmentation

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

    • setReoptimizationBandwidth

      public ReportedRouteBuilder setReoptimizationBandwidth(ReoptimizationBandwidth value)
      Set the property corresponding to ReoptimizationBandwidthObject.getReoptimizationBandwidth() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRro

      public ReportedRouteBuilder setRro(Rro value)
      Set the property corresponding to ReportedRouteObject.getRro() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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