Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.initiated.rev200720

Class Lsp3Builder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Lsp3>, org.opendaylight.yangtools.concepts.CheckedBuilder<Lsp3,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class Lsp3Builder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Lsp3>
    Class that builds Lsp3 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: 

       
     Lsp3 createLsp3(int fooXyzzy, int barBaz) {
         return new Lsp3Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • Lsp3Builder

        public Lsp3Builder()

      • Lsp3Builder

        public Lsp3Builder​(Lsp3 base)

    • Method Detail

      • getCreate

        public Boolean getCreate()

      • build

        public Lsp3 build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Lsp3>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Lsp3,​IllegalArgumentException>