java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instance.protocol.NeighborTransportConfigBuilder

@Generated("mdsal-binding-generator") public class NeighborTransportConfigBuilder extends Object
Class that builds NeighborTransportConfig 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:

   
     NeighborTransportConfig createNeighborTransportConfig(int fooXyzzy, int barBaz) {
         return new NeighborTransportConfigBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • NeighborTransportConfigBuilder

      public NeighborTransportConfigBuilder()
      Construct an empty builder.
    • NeighborTransportConfigBuilder

      public NeighborTransportConfigBuilder(TransportConfig arg)
      Construct a new builder initialized from specified TransportConfig.
      Parameters:
      arg - TransportConfig from which the builder should be initialized
    • NeighborTransportConfigBuilder

      public NeighborTransportConfigBuilder(NeighborTransportConfig base)
      Construct a builder initialized with state from specified NeighborTransportConfig.
      Parameters:
      base - NeighborTransportConfig 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
    • 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 TransportConfig.getRemotePort().
      Returns:
      current value
    • setRemotePort

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

      public @NonNull NeighborTransportConfig build()
      A new NeighborTransportConfig instance.
      Returns:
      A new NeighborTransportConfig instance.