Package org.opendaylight.yang.gen.v1.rpcbench.payload.rev150702.payload

Class PayloadBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.rpcbench.payload.rev150702.payload.PayloadBuilder
@Generated("mdsal-binding-generator") public class PayloadBuilder extends Object
Class that builds Payload 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: 

   
     Payload createPayload(int fooXyzzy, int barBaz) {
         return new PayloadBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PayloadBuilder

      public PayloadBuilder()
      Construct an empty builder.

    • PayloadBuilder

      public PayloadBuilder(Payload base)
      Construct a builder initialized with state from specified Payload.
      Parameters:
      base - Payload from which the builder should be initialized

  • Method Details

    • key

      public PayloadKey key()
      Return current value associated with the property corresponding to Payload.key().
      Returns:
      current value

    • getId

      public Integer getId()
      Return current value associated with the property corresponding to Payload.getId().
      Returns:
      current value

    • augmentation

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

    • setId

      public PayloadBuilder setId(Integer value)
      Set the property corresponding to Payload.getId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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