java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.ExperimenterBuilder

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

   
     Experimenter createExperimenter(int fooXyzzy, int barBaz) {
         return new ExperimenterBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • ExperimenterBuilder

      public ExperimenterBuilder()
      Construct an empty builder.
    • ExperimenterBuilder

      public ExperimenterBuilder(Experimenter base)
      Construct a builder initialized with state from specified Experimenter.
      Parameters:
      base - Experimenter from which the builder should be initialized
  • Method Details

    • getExperimenter

      public org.opendaylight.yangtools.yang.common.Uint32 getExperimenter()
      Return current value associated with the property corresponding to Experimenter.getExperimenter().
      Returns:
      current value
    • getExperimenterBurstSize

      public org.opendaylight.yangtools.yang.common.Uint32 getExperimenterBurstSize()
      Return current value associated with the property corresponding to Experimenter.getExperimenterBurstSize().
      Returns:
      current value
    • getExperimenterRate

      public org.opendaylight.yangtools.yang.common.Uint32 getExperimenterRate()
      Return current value associated with the property corresponding to Experimenter.getExperimenterRate().
      Returns:
      current value
    • getExperimenterType

      public MeterBandType getExperimenterType()
      Return current value associated with the property corresponding to Experimenter.getExperimenterType().
      Returns:
      current value
    • augmentation

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

      public ExperimenterBuilder setExperimenter(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Experimenter.getExperimenter() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setExperimenterBurstSize

      public ExperimenterBuilder setExperimenterBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Experimenter.getExperimenterBurstSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setExperimenterRate

      public ExperimenterBuilder setExperimenterRate(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Experimenter.getExperimenterRate() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setExperimenterType

      public ExperimenterBuilder setExperimenterType(MeterBandType value)
      Set the property corresponding to Experimenter.getExperimenterType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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