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

Class UsersBuilder

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

   
     Users createUsers(int fooXyzzy, int barBaz) {
         return new UsersBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • UsersBuilder

      public UsersBuilder()
      Construct an empty builder.

    • UsersBuilder

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

    • UsersBuilder

      public UsersBuilder(Users base)
      Construct a builder initialized with state from specified Users.
      Parameters:
      base - Users 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 UsersKey key()
      Return current value associated with the property corresponding to Users.key().
      Returns:
      current value

    • getDescription

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

    • getDomainid

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

    • getEmail

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

    • getEnabled

      public Boolean getEnabled()
      Return current value associated with the property corresponding to User.getEnabled().
      Returns:
      current value

    • getName

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

    • getPassword

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

    • getSalt

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

    • getUserid

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

    • augmentation

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

    • setDescription

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

    • setDomainid

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

    • setEmail

      public UsersBuilder setEmail(String value)
      Set the property corresponding to User.getEmail() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEnabled

      public UsersBuilder setEnabled(Boolean value)
      Set the property corresponding to User.getEnabled() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

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

    • setPassword

      public UsersBuilder setPassword(String value)
      Set the property corresponding to User.getPassword() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSalt

      public UsersBuilder setSalt(String value)
      Set the property corresponding to User.getSalt() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setUserid

      public UsersBuilder setUserid(String value)
      Set the property corresponding to User.getUserid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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