Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.radius.server.state

Class CountersBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.radius.server.state.CountersBuilder
@Generated("mdsal-binding-generator") public class CountersBuilder extends Object
Class that builds Counters 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: 

   
     Counters createCounters(int fooXyzzy, int barBaz) {
         return new CountersBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • CountersBuilder

      public CountersBuilder()
      Construct an empty builder.

    • CountersBuilder

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

  • Method Details

    • empty

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

    • getAccessAccepts

      public Counter64 getAccessAccepts()
      Return current value associated with the property corresponding to Counters.getAccessAccepts().
      Returns:
      current value

    • getAccessRejects

      public Counter64 getAccessRejects()
      Return current value associated with the property corresponding to Counters.getAccessRejects().
      Returns:
      current value

    • getRetriedAccessRequests

      public Counter64 getRetriedAccessRequests()
      Return current value associated with the property corresponding to Counters.getRetriedAccessRequests().
      Returns:
      current value

    • getTimeoutAccessRequests

      public Counter64 getTimeoutAccessRequests()
      Return current value associated with the property corresponding to Counters.getTimeoutAccessRequests().
      Returns:
      current value

    • augmentation

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

    • setAccessAccepts

      public CountersBuilder setAccessAccepts(Counter64 value)
      Set the property corresponding to Counters.getAccessAccepts() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAccessRejects

      public CountersBuilder setAccessRejects(Counter64 value)
      Set the property corresponding to Counters.getAccessRejects() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRetriedAccessRequests

      public CountersBuilder setRetriedAccessRequests(Counter64 value)
      Set the property corresponding to Counters.getRetriedAccessRequests() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTimeoutAccessRequests

      public CountersBuilder setTimeoutAccessRequests(Counter64 value)
      Set the property corresponding to Counters.getTimeoutAccessRequests() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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