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

Class AddGroupInputBuilder

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

   
     AddGroupInput createAddGroupInput(int fooXyzzy, int barBaz) {
         return new AddGroupInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AddGroupInputBuilder

      public AddGroupInputBuilder()
      Construct an empty builder.

    • AddGroupInputBuilder

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

    • AddGroupInputBuilder

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

    • AddGroupInputBuilder

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

    • AddGroupInputBuilder

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

    • AddGroupInputBuilder

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

    • getGroupRef

      public GroupRef getGroupRef()
      Return current value associated with the property corresponding to AddGroupInput.getGroupRef().
      Returns:
      current value

    • getGroupType

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

    • getNode

      public NodeRef getNode()
      Return current value associated with the property corresponding to NodeContextRef.getNode().
      Returns:
      current value

    • getTransactionUri

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
      Return current value associated with the property corresponding to TransactionMetadata.getTransactionUri().
      Returns:
      current value

    • augmentation

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

    • setBuckets

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

    • setContainerName

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

    • setGroupId

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

    • setGroupName

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

    • setGroupRef

      public AddGroupInputBuilder setGroupRef(GroupRef value)
      Set the property corresponding to AddGroupInput.getGroupRef() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setGroupType

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

    • setNode

      public AddGroupInputBuilder setNode(NodeRef value)
      Set the property corresponding to NodeContextRef.getNode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTransactionUri

      public AddGroupInputBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
      Set the property corresponding to TransactionMetadata.getTransactionUri() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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