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

Class RoutedRpcBenchInputBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class RoutedRpcBenchInputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<RoutedRpcBenchInput>

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

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

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

RoutedRpcBenchInputBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
RoutedRpcBenchInputBuilder()
RoutedRpcBenchInputBuilder(Payload arg)
RoutedRpcBenchInputBuilder(RoutedRpcBenchInput base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RoutedRpcBenchInputBuilder

public RoutedRpcBenchInputBuilder()

RoutedRpcBenchInputBuilder

public RoutedRpcBenchInputBuilder(Payload arg)

RoutedRpcBenchInputBuilder

public RoutedRpcBenchInputBuilder(RoutedRpcBenchInput 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

getNode

public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> getNode()

getPayload

public List<Payload> getPayload()

augmentation

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

setNode

public RoutedRpcBenchInputBuilder setNode(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> value)

setPayload

public RoutedRpcBenchInputBuilder setPayload(List<Payload> values)

addAugmentation

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

removeAugmentation

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

build

public RoutedRpcBenchInput build()

Specified by:

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