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

Class GroupMessageBuilder

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

   
     GroupMessage createGroupMessage(int fooXyzzy, int barBaz) {
         return new GroupMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • GroupMessageBuilder

      public GroupMessageBuilder()
      Construct an empty builder.

    • GroupMessageBuilder

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

    • GroupMessageBuilder

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

    • GroupMessageBuilder

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

    • getCommand

      public GroupModCommand getCommand()
      Return current value associated with the property corresponding to GroupMessage.getCommand().
      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

    • getVersion

      public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
      Return current value associated with the property corresponding to OfHeader.getVersion().
      Returns:
      current value

    • getXid

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GroupMessage>> 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 GroupMessageBuilder setBarrier(Boolean value)
      Set the property corresponding to Group.getBarrier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBuckets

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

    • setCommand

      public GroupMessageBuilder setCommand(GroupModCommand value)
      Set the property corresponding to GroupMessage.getCommand() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setContainerName

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

    • setGroupId

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

    • setGroupName

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

    • setGroupType

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

    • setVersion

      public GroupMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to OfHeader.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setXid

      public GroupMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to OfHeader.getXid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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