Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.auto.bandwidth.rev181109

Class Bandwidth1Builder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.auto.bandwidth.rev181109.Bandwidth1Builder
@Generated("mdsal-binding-generator") public class Bandwidth1Builder extends Object
Class that builds Bandwidth1 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: 

   
     Bandwidth1 createBandwidth1(int fooXyzzy, int barBaz) {
         return new Bandwidth1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Bandwidth1Builder

      public Bandwidth1Builder()
      Construct an empty builder.

    • Bandwidth1Builder

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

    • Bandwidth1Builder

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

    • getBwSample

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

    • setBwSample

      public Bandwidth1Builder setBwSample(List<Bandwidth> values)
      Set the property corresponding to BwSamples.getBwSample() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • build

      public @NonNull Bandwidth1 build()
      A new Bandwidth1 instance.
      Returns:
      A new Bandwidth1 instance.