Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcc.id.req.object

Class PccIdReqBuilder

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

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

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

    • Constructor Detail

      • PccIdReqBuilder

        public PccIdReqBuilder()

      • PccIdReqBuilder

        public PccIdReqBuilder​(Object arg)

      • PccIdReqBuilder

        public PccIdReqBuilder​(ObjectHeader arg)

      • PccIdReqBuilder

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

      • getIpAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getIpAddress()

      • isIgnore

        public Boolean isIgnore()

      • isProcessingRule

        public Boolean isProcessingRule()

      • augmentation

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

      • setIpAddress

        public PccIdReqBuilder setIpAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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