Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.buckets.grouping

Class BucketsListBuilder

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

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

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

    • Constructor Detail

      • BucketsListBuilder

        public BucketsListBuilder()

      • BucketsListBuilder

        public BucketsListBuilder​(BucketGrouping arg)

      • BucketsListBuilder

        public BucketsListBuilder​(BucketsList 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.openflow.common.action.rev150203.ActionsGrouping
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BucketGrouping
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getWatchGroup

        public org.opendaylight.yangtools.yang.common.Uint32 getWatchGroup()

      • getWeight

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

      • augmentation

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

      • setWatchGroup

        public BucketsListBuilder setWatchGroup​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setWatchGroup

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

      • setWeight

        public BucketsListBuilder setWeight​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setWeight

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

      • addAugmentation

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

      • removeAugmentation

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