Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.defined.sets.bgp.defined.sets.community.sets.community.set

Class CommunitiesBuilder

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

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

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

    • Constructor Detail

      • CommunitiesBuilder

        public CommunitiesBuilder()

      • CommunitiesBuilder

        public CommunitiesBuilder​(Community arg)

      • CommunitiesBuilder

        public CommunitiesBuilder​(Communities 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.bgp.types.rev200120.Community
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getAsNumber

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

      • getSemantics

        public org.opendaylight.yangtools.yang.common.Uint16 getSemantics()

      • augmentation

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

      • setAsNumber

        public CommunitiesBuilder setAsNumber​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)

      • setSemantics

        public CommunitiesBuilder setSemantics​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setSemantics

        @Deprecated(forRemoval=true)
public CommunitiesBuilder setSemantics​(Integer value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setSemantics(Uint16)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • addAugmentation

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

      • removeAugmentation

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