Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message

Class RequestsBuilder

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

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

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

    • Constructor Detail

      • RequestsBuilder

        public RequestsBuilder()

      • RequestsBuilder

        public RequestsBuilder​(RpObject arg)

      • RequestsBuilder

        public RequestsBuilder​(Requests 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.types.rev181109.RpObject
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.VendorInformationObjects
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getRp

        public Rp getRp()

      • augmentation

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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