Package org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets

Class BucketBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Bucket>, org.opendaylight.yangtools.concepts.CheckedBuilder<Bucket,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class BucketBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Bucket>
    Class that builds Bucket 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: 

       
     Bucket createBucket(int fooXyzzy, int barBaz) {
         return new BucketBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • BucketBuilder

        public BucketBuilder()

      • BucketBuilder

        public BucketBuilder​(ActionList arg)

      • BucketBuilder

        public BucketBuilder​(Bucket 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:
        • ActionList
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getBucketId

        public BucketId getBucketId()

      • getWatchGroup

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

      • getWatchPort

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

      • getWeight

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

      • augmentation

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

      • setWatchGroup

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

      • setWatchPort

        public BucketBuilder setWatchPort​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setWeight

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

      • addAugmentation

        public BucketBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Bucket> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null

      • removeAugmentation

        public BucketBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bucket>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder

      • build

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