Package org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update

Class UpdatedGroupBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.UpdatedGroupBuilder
@Generated("mdsal-binding-generator") public class UpdatedGroupBuilder extends Object
Class that builds UpdatedGroup 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: 

   
     UpdatedGroup createUpdatedGroup(int fooXyzzy, int barBaz) {
         return new UpdatedGroupBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • UpdatedGroupBuilder

      public UpdatedGroupBuilder()
      Construct an empty builder.

    • UpdatedGroupBuilder

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

    • UpdatedGroupBuilder

      public UpdatedGroupBuilder(UpdatedGroup base)
      Construct a builder initialized with state from specified UpdatedGroup.
      Parameters:
      base - UpdatedGroup 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

    • getBarrier

      public Boolean getBarrier()
      Return current value associated with the property corresponding to Group.getBarrier().
      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<UpdatedGroup>> 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

    • setBarrier

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

    • setBuckets

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

    • setContainerName

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

    • setGroupId

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

    • setGroupName

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

    • setGroupType

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

    • addAugmentation

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