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

Class AuthorizationBuilder

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

   
     Authorization createAuthorization(int fooXyzzy, int barBaz) {
         return new AuthorizationBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AuthorizationBuilder

      public AuthorizationBuilder()
      Construct an empty builder.

    • AuthorizationBuilder

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

    • AuthorizationBuilder

      public AuthorizationBuilder(Authorization base)
      Construct a builder initialized with state from specified Authorization.
      Parameters:
      base - Authorization 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 Authorization empty()
      Get empty instance of Authorization.
      Returns:
      An empty Authorization

    • getConfig

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

    • getEvents

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

    • getState

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Authorization>> 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 AuthorizationBuilder setConfig(Config value)
      Set the property corresponding to Authorization.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEvents

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

    • setState

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

    • addAugmentation

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