Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.aaa.rev161214

Class AuthenticationBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.aaa.rev161214.AuthenticationBuilder
@Generated("mdsal-binding-generator") public class AuthenticationBuilder extends Object
Class that builds Authentication 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: 

   
     Authentication createAuthentication(int fooXyzzy, int barBaz) {
         return new AuthenticationBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AuthenticationBuilder

      public AuthenticationBuilder()
      Construct an empty builder.

    • AuthenticationBuilder

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

  • Method Details

    • empty

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

    • getDomains

      public Domains getDomains()
      Return current value associated with the property corresponding to Authentication.getDomains().
      Returns:
      current value

    • getGrants

      public Grants getGrants()
      Return current value associated with the property corresponding to Authentication.getGrants().
      Returns:
      current value

    • getRoles

      public Roles getRoles()
      Return current value associated with the property corresponding to Authentication.getRoles().
      Returns:
      current value

    • getUsers

      public Users getUsers()
      Return current value associated with the property corresponding to Authentication.getUsers().
      Returns:
      current value

    • augmentation

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

    • setDomains

      public AuthenticationBuilder setDomains(Domains value)
      Set the property corresponding to Authentication.getDomains() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setGrants

      public AuthenticationBuilder setGrants(Grants value)
      Set the property corresponding to Authentication.getGrants() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRoles

      public AuthenticationBuilder setRoles(Roles value)
      Set the property corresponding to Authentication.getRoles() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setUsers

      public AuthenticationBuilder setUsers(Users value)
      Set the property corresponding to Authentication.getUsers() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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