Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.output

Class ResultBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.output.ResultBuilder
@Generated("mdsal-binding-generator") public class ResultBuilder extends Object
Class that builds Result 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: 

   
     Result createResult(int fooXyzzy, int barBaz) {
         return new ResultBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ResultBuilder

      public ResultBuilder()
      Construct an empty builder.

    • ResultBuilder

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

  • Method Details

    • empty

      public static @NonNull Result empty()
      Get empty instance of Result.
      Returns:
      An empty Result

    • getCount

      public org.opendaylight.yangtools.yang.common.Uint32 getCount()
      Return current value associated with the property corresponding to Result.getCount().
      Returns:
      current value

    • getDuration

      public org.opendaylight.yangtools.yang.common.Uint32 getDuration()
      Return current value associated with the property corresponding to Result.getDuration().
      Returns:
      current value

    • getRate

      public org.opendaylight.yangtools.yang.common.Uint32 getRate()
      Return current value associated with the property corresponding to Result.getRate().
      Returns:
      current value

    • augmentation

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

    • setCount

      public ResultBuilder setCount(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Result.getCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setDuration

      public ResultBuilder setDuration(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Result.getDuration() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRate

      public ResultBuilder setRate(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Result.getRate() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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