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

Class RolesBuilder

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

   
     Roles createRoles(int fooXyzzy, int barBaz) {
         return new RolesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • RolesBuilder

      public RolesBuilder()
      Construct an empty builder.

    • RolesBuilder

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

    • RolesBuilder

      public RolesBuilder(Roles base)
      Construct a builder initialized with state from specified Roles.
      Parameters:
      base - Roles 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

    • key

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

    • getDescription

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

    • getDomainid

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

    • getName

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

    • getRoleid

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

    • augmentation

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

    • setDescription

      public RolesBuilder setDescription(String value)
      Set the property corresponding to Role.getDescription() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setDomainid

      public RolesBuilder setDomainid(String value)
      Set the property corresponding to Role.getDomainid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

      public RolesBuilder setName(String value)
      Set the property corresponding to Role.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRoleid

      public RolesBuilder setRoleid(String value)
      Set the property corresponding to Role.getRoleid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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