Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.data.change.counter.rev160315.data.change.counter

Class CounterBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.data.change.counter.rev160315.data.change.counter.CounterBuilder
@Generated("mdsal-binding-generator") public class CounterBuilder extends Object
Class that builds Counter 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: 

   
     Counter createCounter(int fooXyzzy, int barBaz) {
         return new CounterBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • CounterBuilder

      public CounterBuilder()
      Construct an empty builder.

    • CounterBuilder

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

  • Method Details

    • key

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

    • getCount

      public org.opendaylight.yangtools.yang.common.Uint32 getCount()
      Return current value associated with the property corresponding to Counter.getCount().
      Returns:
      current value

    • getId

      public String getId()
      Return current value associated with the property corresponding to Counter.getId().
      Returns:
      current value

    • augmentation

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

    • setCount

      public CounterBuilder setCount(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Counter.getCount() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setId

      public CounterBuilder setId(String value)
      Set the property corresponding to Counter.getId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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