Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics

Class MeterBandStatsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.MeterBandStatsBuilder
@Generated("mdsal-binding-generator") public class MeterBandStatsBuilder extends Object
Class that builds MeterBandStats 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: 

   
     MeterBandStats createMeterBandStats(int fooXyzzy, int barBaz) {
         return new MeterBandStatsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MeterBandStatsBuilder

      public MeterBandStatsBuilder()
      Construct an empty builder.

    • MeterBandStatsBuilder

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

  • Method Details

    • empty

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

    • getBandStat

      public Map<BandStatKey,BandStat> getBandStat()
      Return current value associated with the property corresponding to MeterBandStats.getBandStat().
      Returns:
      current value

    • augmentation

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

    • setBandStat

      public MeterBandStatsBuilder setBandStat(Map<BandStatKey,BandStat> values)
      Set the property corresponding to MeterBandStats.getBandStat() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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