Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.cluster.admin.rev151013.get.known.clients._for.all.shards.output.shard.result

Class KnownClientsBuilder

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

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

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

    • Constructor Detail

      • KnownClientsBuilder

        public KnownClientsBuilder()

      • KnownClientsBuilder

        public KnownClientsBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.ClientIdentifier arg)

      • KnownClientsBuilder

        public KnownClientsBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.FrontendIdentifier arg)

      • KnownClientsBuilder

        public KnownClientsBuilder​(KnownClients 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.controller.cds.types.rev191024.FrontendIdentifier
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.ClientIdentifier
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getGeneration

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.ClientGeneration getGeneration()

      • getMember

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.MemberName getMember()

      • getType

        public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.FrontendType getType()

      • augmentation

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

      • setGeneration

        public KnownClientsBuilder setGeneration​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.ClientGeneration value)

      • setMember

        public KnownClientsBuilder setMember​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.MemberName value)

      • setType

        public KnownClientsBuilder setType​(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024.FrontendType value)

      • addAugmentation

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