org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819

Class UpdateFlowOutputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowOutputBuilder

All Implemented Interfaces:

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

public class UpdateFlowOutputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<UpdateFlowOutput>

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

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

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

UpdateFlowOutputBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
UpdateFlowOutputBuilder()
UpdateFlowOutputBuilder(TransactionAware arg)
UpdateFlowOutputBuilder(UpdateFlowOutput base)

Method Summary

Modifier and Type	Method and Description
UpdateFlowOutputBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowOutput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowOutput>> E$$	augmentation(Class<E$$> augmentationType)
UpdateFlowOutput	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
TransactionId	getTransactionId()
UpdateFlowOutputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowOutput>> augmentationType)
UpdateFlowOutputBuilder	setTransactionId(TransactionId value)

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateFlowOutputBuilder

public UpdateFlowOutputBuilder()

UpdateFlowOutputBuilder

public UpdateFlowOutputBuilder(TransactionAware arg)

UpdateFlowOutputBuilder

public UpdateFlowOutputBuilder(UpdateFlowOutput 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.urn.opendaylight.flow.transaction.rev150304.TransactionAware

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getTransactionId

public TransactionId getTransactionId()

augmentation

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

setTransactionId

public UpdateFlowOutputBuilder setTransactionId(TransactionId value)

addAugmentation

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

removeAugmentation

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

build

public UpdateFlowOutput build()

Specified by:

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