java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.statistics.buckets.BucketCounterBuilder

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

   
     BucketCounter createBucketCounter(int fooXyzzy, int barBaz) {
         return new BucketCounterBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • BucketCounterBuilder

      public BucketCounterBuilder()
      Construct an empty builder.
    • BucketCounterBuilder

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

    • key

      public BucketCounterKey key()
      Return current value associated with the property corresponding to BucketCounter.key().
      Returns:
      current value
    • getBucketId

      public BucketId getBucketId()
      Return current value associated with the property corresponding to BucketCounter.getBucketId().
      Returns:
      current value
    • getByteCount

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

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

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BucketCounter>> 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 BucketCounterBuilder withKey(BucketCounterKey key)
      Set the key value corresponding to BucketCounter.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder
    • setBucketId

      public BucketCounterBuilder setBucketId(BucketId value)
      Set the property corresponding to BucketCounter.getBucketId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setByteCount

      public BucketCounterBuilder setByteCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
      Set the property corresponding to BucketCounter.getByteCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setPacketCount

      public BucketCounterBuilder setPacketCount(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter64 value)
      Set the property corresponding to BucketCounter.getPacketCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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