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

Class PayloadBuilder

java.lang.Object

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

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<Payload>, org.opendaylight.yangtools.concepts.CheckedBuilder<Payload,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class PayloadBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Payload>

Class that builds PayloadBuilder 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:

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

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

PayloadBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PayloadBuilder()
PayloadBuilder(Payload base)

Method Summary

Modifier and Type	Method and Description
PayloadBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Payload>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Payload> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Payload>> E$$	augmentation(Class<E$$> augmentationType)
Payload	build()
Integer	getId()
PayloadKey	key()
PayloadBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Payload>> augmentationType)
PayloadBuilder	setId(Integer value)
PayloadBuilder	withKey(PayloadKey key)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PayloadBuilder

public PayloadBuilder()

PayloadBuilder

public PayloadBuilder(Payload base)

Method Detail

key

public PayloadKey key()

getId

public Integer getId()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Payload>> E$$ augmentation(Class<E$$> augmentationType)

withKey

public PayloadBuilder withKey(PayloadKey key)

setId

public PayloadBuilder setId(Integer value)

addAugmentation

public PayloadBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Payload>> augmentationType,
                                      org.opendaylight.yangtools.yang.binding.Augmentation<Payload> augmentationValue)

removeAugmentation

public PayloadBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Payload>> augmentationType)

build

public Payload build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Payload,IllegalArgumentException>