Class Tlvs2Builder

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

         Tlvs2 createTlvs2(int fooXyzzy, int barBaz) {
             return new Tlvs2Builder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • Tlvs2Builder

        public Tlvs2Builder()
        Construct an empty builder.
      • Tlvs2Builder

        public Tlvs2Builder​(LspDbVersionTlv arg)
        Construct a new builder initialized from specified LspDbVersionTlv.
        arg - LspDbVersionTlv from which the builder should be initialized
      • Tlvs2Builder

        public Tlvs2Builder​(Tlvs2 base)
        Construct a builder initialized with state from specified Tlvs2.
        base - Tlvs2 from which the builder should be initialized
    • Method Detail

      • 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:
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • build

        public @NonNull Tlvs2 build()
        A new Tlvs2 instance.
        A new Tlvs2 instance.