Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class GroupModInputBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GroupModInputBuilder
@Generated("mdsal-binding-generator") public class GroupModInputBuilder extends Object
Class that builds GroupModInput 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: 

   
     GroupModInput createGroupModInput(int fooXyzzy, int barBaz) {
         return new GroupModInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • GroupModInputBuilder

      public GroupModInputBuilder()
      Construct an empty builder.

    • GroupModInputBuilder

      public GroupModInputBuilder(GroupMod$G arg)
      Construct a new builder initialized from specified GroupMod$G.
      Parameters:
      arg - GroupMod$G from which the builder should be initialized

    • GroupModInputBuilder

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

    • GroupModInputBuilder

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

    • GroupModInputBuilder

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

    • getBucketsList

      public List<BucketsList> getBucketsList()
      Return current value associated with the property corresponding to BucketsGrouping.getBucketsList().
      Returns:
      current value

    • getCommand

      public GroupModCommand getCommand()
      Return current value associated with the property corresponding to GroupMod$G.getCommand().
      Returns:
      current value

    • getGroupId

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

    • getType

      public GroupType getType()
      Return current value associated with the property corresponding to GroupMod$G.getType().
      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<GroupModInput>> 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

    • setBucketsList

      public GroupModInputBuilder setBucketsList(List<BucketsList> values)
      Set the property corresponding to BucketsGrouping.getBucketsList() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setCommand

      public GroupModInputBuilder setCommand(GroupModCommand value)
      Set the property corresponding to GroupMod$G.getCommand() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setGroupId

      public GroupModInputBuilder setGroupId(GroupId value)
      Set the property corresponding to GroupMod$G.getGroupId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setType

      public GroupModInputBuilder setType(GroupType value)
      Set the property corresponding to GroupMod$G.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

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