org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.set.tp.src._case

Class SetTpSrcActionBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.set.tp.src._case.SetTpSrcActionBuilder

All Implemented Interfaces:

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

public class SetTpSrcActionBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SetTpSrcAction>

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

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

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

SetTpSrcActionBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SetTpSrcActionBuilder()
SetTpSrcActionBuilder(SetTpSrcAction base)

Method Summary

Modifier and Type	Method and Description
SetTpSrcActionBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetTpSrcAction>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SetTpSrcAction> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetTpSrcAction>> E$$	augmentation(Class<E$$> augmentationType)
SetTpSrcAction	build()
PortNumber	getPort()
SetTpSrcActionBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetTpSrcAction>> augmentationType)
SetTpSrcActionBuilder	setPort(PortNumber value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SetTpSrcActionBuilder

public SetTpSrcActionBuilder()

SetTpSrcActionBuilder

public SetTpSrcActionBuilder(SetTpSrcAction base)

Method Detail

getPort

public PortNumber getPort()

augmentation

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

setPort

public SetTpSrcActionBuilder setPort(PortNumber value)

addAugmentation

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

removeAugmentation

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

build

public SetTpSrcAction build()

Specified by:

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