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

Class ConnectionParametersBuilder

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

   
     ConnectionParameters createConnectionParameters(int fooXyzzy, int barBaz) {
         return new ConnectionParametersBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ConnectionParametersBuilder

      public ConnectionParametersBuilder()
      Construct an empty builder.

    • ConnectionParametersBuilder

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

    • ConnectionParametersBuilder

      public ConnectionParametersBuilder(Credentials arg)
      Construct a new builder initialized from specified Credentials.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.Credentials from which the builder should be initialized

    • ConnectionParametersBuilder

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

    • getCredentials

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

    • getHost

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host getHost()
      Return current value associated with the property corresponding to ConnectionParameters.getHost().
      Returns:
      current value

    • getPort

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()
      Return current value associated with the property corresponding to ConnectionParameters.getPort().
      Returns:
      current value

    • getSecurityChoice

      public SecurityChoice getSecurityChoice()
      Return current value associated with the property corresponding to Security.getSecurityChoice().
      Returns:
      current value

    • augmentation

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

    • setCredentials

      public ConnectionParametersBuilder setCredentials(Credentials value)
      Set the property corresponding to Credentials.getCredentials() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHost

      public ConnectionParametersBuilder setHost(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host value)
      Set the property corresponding to ConnectionParameters.getHost() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPort

      public ConnectionParametersBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
      Set the property corresponding to ConnectionParameters.getPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSecurityChoice

      public ConnectionParametersBuilder setSecurityChoice(SecurityChoice value)
      Set the property corresponding to Security.getSecurityChoice() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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