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

Class BucketBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.BucketBuilder
@Generated("mdsal-binding-generator") public class BucketBuilder extends Object
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:

  • Constructor Details

    • BucketBuilder

      public BucketBuilder()
      Construct an empty builder.

    • BucketBuilder

      public BucketBuilder(ActionList arg)
      Construct a new builder initialized from specified ActionList.
      Parameters:
      arg - ActionList from which the builder should be initialized

    • BucketBuilder

      public BucketBuilder(Bucket base)
      Construct a builder initialized with state from specified Bucket.
      Parameters:
      base - Bucket from which the builder should be initialized

  • Method Details

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

    • key

      public BucketKey key()
      Return current value associated with the property corresponding to Bucket.key().
      Returns:
      current value

    • getAction

      public Map<ActionKey,Action> getAction()
      Return current value associated with the property corresponding to ActionList.getAction().
      Returns:
      current value

    • getBucketId

      public BucketId getBucketId()
      Return current value associated with the property corresponding to Bucket.getBucketId().
      Returns:
      current value

    • getWatchGroup

      public org.opendaylight.yangtools.yang.common.Uint32 getWatchGroup()
      Return current value associated with the property corresponding to Bucket.getWatchGroup().
      Returns:
      current value

    • getWatchPort

      public org.opendaylight.yangtools.yang.common.Uint32 getWatchPort()
      Return current value associated with the property corresponding to Bucket.getWatchPort().
      Returns:
      current value

    • getWeight

      public org.opendaylight.yangtools.yang.common.Uint16 getWeight()
      Return current value associated with the property corresponding to Bucket.getWeight().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bucket>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      Parameters:
      augmentationType - augmentation type class
      Returns:
      Augmentation object from this builder, or null if not present
      Throws:
      NullPointerException - if augmentType is null

    • withKey

      public BucketBuilder withKey(BucketKey key)
      Set the key value corresponding to Bucket.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setAction

      public BucketBuilder setAction(Map<ActionKey,Action> values)
      Set the property corresponding to ActionList.getAction() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setBucketId

      public BucketBuilder setBucketId(BucketId value)
      Set the property corresponding to Bucket.getBucketId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setWatchGroup

      public BucketBuilder setWatchGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Bucket.getWatchGroup() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setWatchPort

      public BucketBuilder setWatchPort(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Bucket.getWatchPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setWeight

      public BucketBuilder setWeight(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to Bucket.getWeight() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • 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 @NonNull Bucket build()
      A new Bucket instance.
      Returns:
      A new Bucket instance.