Package org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.credentials

Class CredentialsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.credentials.CredentialsBuilder
@Generated("mdsal-binding-generator") public class CredentialsBuilder extends Object
Class that builds Credentials 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: 

   
     Credentials createCredentials(int fooXyzzy, int barBaz) {
         return new CredentialsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • CredentialsBuilder

      public CredentialsBuilder()
      Construct an empty builder.

    • CredentialsBuilder

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

  • Method Details

    • empty

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

    • getPassword

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

    • getUsername

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

    • augmentation

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

    • setPassword

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

    • setUsername

      public CredentialsBuilder setUsername(String value)
      Set the property corresponding to Credentials.getUsername() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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