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

Class RoutedRpcBenchOutputBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class RoutedRpcBenchOutputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<RoutedRpcBenchOutput>

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

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

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

RoutedRpcBenchOutputBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
RoutedRpcBenchOutputBuilder()
RoutedRpcBenchOutputBuilder(Payload arg)
RoutedRpcBenchOutputBuilder(RoutedRpcBenchOutput base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RoutedRpcBenchOutputBuilder

public RoutedRpcBenchOutputBuilder()

RoutedRpcBenchOutputBuilder

public RoutedRpcBenchOutputBuilder(Payload arg)

RoutedRpcBenchOutputBuilder

public RoutedRpcBenchOutputBuilder(RoutedRpcBenchOutput 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<RoutedRpcBenchOutput>> E$$ augmentation(Class<E$$> augmentationType)

setPayload

public RoutedRpcBenchOutputBuilder setPayload(List<Payload> values)

addAugmentation

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

removeAugmentation

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

build

public RoutedRpcBenchOutput build()

Specified by:

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