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

Class BandStatBuilder

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

   
     BandStat createBandStat(int fooXyzzy, int barBaz) {
         return new BandStatBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • BandStatBuilder

      public BandStatBuilder()
      Construct an empty builder.

    • BandStatBuilder

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

  • Method Details

    • key

      public BandStatKey key()
      Return current value associated with the property corresponding to BandStat.key().
      Returns:
      current value

    • getBandId

      public BandId getBandId()
      Return current value associated with the property corresponding to BandStat.getBandId().
      Returns:
      current value

    • getByteBandCount

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getByteBandCount()
      Return current value associated with the property corresponding to BandStat.getByteBandCount().
      Returns:
      current value

    • getPacketBandCount

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 getPacketBandCount()
      Return current value associated with the property corresponding to BandStat.getPacketBandCount().
      Returns:
      current value

    • augmentation

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

    • withKey

      public BandStatBuilder withKey(BandStatKey key)
      Set the key value corresponding to BandStat.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setBandId

      public BandStatBuilder setBandId(BandId value)
      Set the property corresponding to BandStat.getBandId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setByteBandCount

      public BandStatBuilder setByteBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
      Set the property corresponding to BandStat.getByteBandCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPacketBandCount

      public BandStatBuilder setPacketBandCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
      Set the property corresponding to BandStat.getPacketBandCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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