Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev181109.pcerr.pcerr.message.error.type.stateful._case.stateful

Class SrpsBuilder

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

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

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

    • Constructor Detail

      • SrpsBuilder

        public SrpsBuilder()

      • SrpsBuilder

        public SrpsBuilder​(SrpObject arg)

      • SrpsBuilder

        public SrpsBuilder​(Srps 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.pcep.ietf.stateful.rev181109.SrpObject
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getSrp

        public Srp getSrp()

      • augmentation

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

      • addAugmentation

        public SrpsBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Srps>> augmentationType,
                                   org.opendaylight.yangtools.yang.binding.Augmentation<Srps> augmentationValue)

      • removeAugmentation

        public SrpsBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Srps>> augmentationType)

      • build

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