Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.accounting.top

Class AccountingBuilder

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

   
     Accounting createAccounting(int fooXyzzy, int barBaz) {
         return new AccountingBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AccountingBuilder

      public AccountingBuilder()
      Construct an empty builder.

    • AccountingBuilder

      public AccountingBuilder(AaaAccountingEventsTop arg)
      Construct a new builder initialized from specified AaaAccountingEventsTop.
      Parameters:
      arg - AaaAccountingEventsTop from which the builder should be initialized

    • AccountingBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • empty

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

    • getConfig

      public Config getConfig()
      Return current value associated with the property corresponding to Accounting.getConfig().
      Returns:
      current value

    • getEvents

      public Events getEvents()
      Return current value associated with the property corresponding to AaaAccountingEventsTop.getEvents().
      Returns:
      current value

    • getState

      public State getState()
      Return current value associated with the property corresponding to Accounting.getState().
      Returns:
      current value

    • augmentation

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

    • setConfig

      public AccountingBuilder setConfig(Config value)
      Set the property corresponding to Accounting.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEvents

      public AccountingBuilder setEvents(Events value)
      Set the property corresponding to AaaAccountingEventsTop.getEvents() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

      public AccountingBuilder setState(State value)
      Set the property corresponding to Accounting.getState() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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