@Generated("mdsal-binding-generator") public class Bandwidth2Builder extends Object
Class that builds Bandwidth2 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:

     Bandwidth2 createBandwidth2(int fooXyzzy, int barBaz) {
         return new Bandwidth2Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())

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

    • Bandwidth2Builder

      public Bandwidth2Builder()
      Construct an empty builder.
    • Bandwidth2Builder

      public Bandwidth2Builder(BwSamples arg)
      Construct a new builder initialized from specified BwSamples.
      arg - BwSamples from which the builder should be initialized
    • Bandwidth2Builder

      public Bandwidth2Builder(Bandwidth2 base)
      Construct a builder initialized with state from specified Bandwidth2.
      base - Bandwidth2 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:
      arg - grouping object
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
    • getBwSample

      public List<Bandwidth> getBwSample()
      Return current value associated with the property corresponding to BwSamples.getBwSample().
      current value
    • setBwSample

      public Bandwidth2Builder setBwSample(List<Bandwidth> values)
      Set the property corresponding to BwSamples.getBwSample() to the specified value.
      values - desired value
      this builder
    • build

      public @NonNull Bandwidth2 build()
      A new Bandwidth2 instance.
      A new Bandwidth2 instance.