Package org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.group.crud._case.aug.flat.batch.add.group._case

Class FlatBatchAddGroupBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.group.crud._case.aug.flat.batch.add.group._case.FlatBatchAddGroupBuilder
@Generated("mdsal-binding-generator") public class FlatBatchAddGroupBuilder extends Object
Class that builds FlatBatchAddGroup 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: 

   
     FlatBatchAddGroup createFlatBatchAddGroup(int fooXyzzy, int barBaz) {
         return new FlatBatchAddGroupBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • FlatBatchAddGroupBuilder

      public FlatBatchAddGroupBuilder()
      Construct an empty builder.

    • FlatBatchAddGroupBuilder

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

    • FlatBatchAddGroupBuilder

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

    • FlatBatchAddGroupBuilder

      public FlatBatchAddGroupBuilder(FlatBatchAddGroup base)
      Construct a builder initialized with state from specified FlatBatchAddGroup.
      Parameters:
      base - FlatBatchAddGroup 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 FlatBatchAddGroupKey key()
      Return current value associated with the property corresponding to FlatBatchAddGroup.key().
      Returns:
      current value

    • getBarrier

      public Boolean getBarrier()
      Return current value associated with the property corresponding to Group.getBarrier().
      Returns:
      current value

    • getBatchOrder

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

    • getBuckets

      public Buckets getBuckets()
      Return current value associated with the property corresponding to Group.getBuckets().
      Returns:
      current value

    • getContainerName

      public String getContainerName()
      Return current value associated with the property corresponding to Group.getContainerName().
      Returns:
      current value

    • getGroupId

      public GroupId getGroupId()
      Return current value associated with the property corresponding to Group.getGroupId().
      Returns:
      current value

    • getGroupName

      public String getGroupName()
      Return current value associated with the property corresponding to Group.getGroupName().
      Returns:
      current value

    • getGroupType

      public GroupTypes getGroupType()
      Return current value associated with the property corresponding to Group.getGroupType().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> 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 FlatBatchAddGroupBuilder withKey(FlatBatchAddGroupKey key)
      Set the key value corresponding to FlatBatchAddGroup.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setBarrier

      public FlatBatchAddGroupBuilder setBarrier(Boolean value)
      Set the property corresponding to Group.getBarrier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBatchOrder

      public FlatBatchAddGroupBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to BatchOrderGrouping.getBatchOrder() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBuckets

      public FlatBatchAddGroupBuilder setBuckets(Buckets value)
      Set the property corresponding to Group.getBuckets() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setContainerName

      public FlatBatchAddGroupBuilder setContainerName(String value)
      Set the property corresponding to Group.getContainerName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setGroupId

      public FlatBatchAddGroupBuilder setGroupId(GroupId value)
      Set the property corresponding to Group.getGroupId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setGroupName

      public FlatBatchAddGroupBuilder setGroupName(String value)
      Set the property corresponding to Group.getGroupName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setGroupType

      public FlatBatchAddGroupBuilder setGroupType(GroupTypes value)
      Set the property corresponding to Group.getGroupType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public FlatBatchAddGroupBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup> 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 FlatBatchAddGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchAddGroup>> 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 FlatBatchAddGroup build()
      A new FlatBatchAddGroup instance.
      Returns:
      A new FlatBatchAddGroup instance.