Class RemoveLspInputBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<RemoveLspInput>, org.opendaylight.yangtools.concepts.CheckedBuilder<RemoveLspInput,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class RemoveLspInputBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<RemoveLspInput>
    Class that builds RemoveLspInput 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:

         RemoveLspInput createRemoveLspInput(int fooXyzzy, int barBaz) {
             return new RemoveLspInputBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • RemoveLspInputBuilder

        public RemoveLspInputBuilder()
      • RemoveLspInputBuilder

        public RemoveLspInputBuilder​(RemoveLspArgs arg)
      • RemoveLspInputBuilder

        public RemoveLspInputBuilder​(LspId arg)
      • RemoveLspInputBuilder

        public RemoveLspInputBuilder​(NodeId arg)
      • RemoveLspInputBuilder

        public RemoveLspInputBuilder​(RemoveLspInput 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.pcep.rev200120.NodeId
        • RemoveLspArgs
        • NetworkTopologyReference
        • LspId
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getName

        public String getName()
      • getNode

        public getNode()
      • augmentation

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

        public RemoveLspInputBuilder setNode​( value)
      • addAugmentation

        public RemoveLspInputBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<RemoveLspInput> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        NullPointerException - if augmentation is null
      • removeAugmentation

        public RemoveLspInputBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoveLspInput>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        augmentationType - augmentation type to be removed
        this builder