Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes

Class ConnectionInfoBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ConnectionInfoBuilder
@Generated("mdsal-binding-generator") public class ConnectionInfoBuilder extends Object
Class that builds ConnectionInfo 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: 

   
     ConnectionInfo createConnectionInfo(int fooXyzzy, int barBaz) {
         return new ConnectionInfoBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ConnectionInfoBuilder

      public ConnectionInfoBuilder()
      Construct an empty builder.

    • ConnectionInfoBuilder

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

    • ConnectionInfoBuilder

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

    • getLocalIp

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

    • getLocalPort

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

    • getRemoteIp

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

    • getRemotePort

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

    • augmentation

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

    • setLocalIp

      public ConnectionInfoBuilder setLocalIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to OvsdbConnectionInfoAttributes.getLocalIp() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalPort

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

    • setRemoteIp

      public ConnectionInfoBuilder setRemoteIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to OvsdbConnectionInfoAttributes.getRemoteIp() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemotePort

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

    • addAugmentation

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