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

Class GlobalRpcBenchInputBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class GlobalRpcBenchInputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<GlobalRpcBenchInput>

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

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

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

GlobalRpcBenchInputBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
GlobalRpcBenchInputBuilder()
GlobalRpcBenchInputBuilder(GlobalRpcBenchInput base)
GlobalRpcBenchInputBuilder(Payload arg)

Method Summary

Modifier and Type	Method and Description
GlobalRpcBenchInputBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GlobalRpcBenchInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GlobalRpcBenchInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GlobalRpcBenchInput>> E$$	augmentation(Class<E$$> augmentationType)
GlobalRpcBenchInput	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<Payload>	getPayload()
GlobalRpcBenchInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GlobalRpcBenchInput>> augmentationType)
GlobalRpcBenchInputBuilder	setPayload(List<Payload> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalRpcBenchInputBuilder

public GlobalRpcBenchInputBuilder()

GlobalRpcBenchInputBuilder

public GlobalRpcBenchInputBuilder(Payload arg)

GlobalRpcBenchInputBuilder

public GlobalRpcBenchInputBuilder(GlobalRpcBenchInput base)

Method Detail

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:

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

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getPayload

public List<Payload> getPayload()

augmentation

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

setPayload

public GlobalRpcBenchInputBuilder setPayload(List<Payload> values)

addAugmentation

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

removeAugmentation

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

build

public GlobalRpcBenchInput build()

Specified by:

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