Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.programming.rev181109

Class SubmitAddLspInputBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<SubmitAddLspInput>, org.opendaylight.yangtools.concepts.CheckedBuilder<SubmitAddLspInput,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class SubmitAddLspInputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SubmitAddLspInput>
    Class that builds SubmitAddLspInputBuilder 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: 

       
     SubmitAddLspInputBuilder createTarget(int fooXyzzy, int barBaz) {
         return new SubmitAddLspInputBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • SubmitAddLspInputBuilder

        public SubmitAddLspInputBuilder()

      • SubmitAddLspInputBuilder

        public SubmitAddLspInputBuilder​(AddLspArgs arg)

      • SubmitAddLspInputBuilder

        public SubmitAddLspInputBuilder​(LspId arg)

      • SubmitAddLspInputBuilder

        public SubmitAddLspInputBuilder​(NodeId arg)

      • SubmitAddLspInputBuilder

        public SubmitAddLspInputBuilder​(SubmitAddLspInput base)

    • 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.programming.rev131102.TopologyInstructionInput
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.SubmitInstructionInput
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.NodeId
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.topology.rev140113.NetworkTopologyReference
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.LspId
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.AddLspArgs
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getArguments

        public Arguments getArguments()

      • getDeadline

        public Nanotime getDeadline()

      • getName

        public String getName()

      • getNode

        public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getNode()

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubmitAddLspInput>> E$$ augmentation​(Class<E$$> augmentationType)

      • setNode

        public SubmitAddLspInputBuilder setNode​(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)