Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.node.state

Class SrCapabilitiesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.node.state.SrCapabilitiesBuilder
@Generated("mdsal-binding-generator") public class SrCapabilitiesBuilder extends Object
Class that builds SrCapabilities 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: 

   
     SrCapabilities createSrCapabilities(int fooXyzzy, int barBaz) {
         return new SrCapabilitiesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrCapabilitiesBuilder

      public SrCapabilitiesBuilder()
      Construct an empty builder.

    • SrCapabilitiesBuilder

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

    • SrCapabilitiesBuilder

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

    • SrCapabilitiesBuilder

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

    • SrCapabilitiesBuilder

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

    • SrCapabilitiesBuilder

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

  • Method Details