org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.transmit.packet.input.action.action

Class NxActionEncapRpcTransmitPacketCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.transmit.packet.input.action.action.NxActionEncapRpcTransmitPacketCaseBuilder

All Implemented Interfaces:

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

public class NxActionEncapRpcTransmitPacketCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxActionEncapRpcTransmitPacketCase>

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

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

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

NxActionEncapRpcTransmitPacketCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxActionEncapRpcTransmitPacketCaseBuilder()
NxActionEncapRpcTransmitPacketCaseBuilder(NxActionEncapGrouping arg)
NxActionEncapRpcTransmitPacketCaseBuilder(NxActionEncapRpcTransmitPacketCase base)

Method Summary

Modifier and Type	Method and Description
NxActionEncapRpcTransmitPacketCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapRpcTransmitPacketCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapRpcTransmitPacketCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapRpcTransmitPacketCase>> E$$	augmentation(Class<E$$> augmentationType)
NxActionEncapRpcTransmitPacketCase	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
NxEncap	getNxEncap()
NxActionEncapRpcTransmitPacketCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncapRpcTransmitPacketCase>> augmentationType)
NxActionEncapRpcTransmitPacketCaseBuilder	setNxEncap(NxEncap value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxActionEncapRpcTransmitPacketCaseBuilder

public NxActionEncapRpcTransmitPacketCaseBuilder()

NxActionEncapRpcTransmitPacketCaseBuilder

public NxActionEncapRpcTransmitPacketCaseBuilder(NxActionEncapGrouping arg)

NxActionEncapRpcTransmitPacketCaseBuilder

public NxActionEncapRpcTransmitPacketCaseBuilder(NxActionEncapRpcTransmitPacketCase 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.openflowplugin.extension.nicira.action.rev140714.NxActionEncapGrouping

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getNxEncap

public NxEncap getNxEncap()

augmentation

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

setNxEncap

public NxActionEncapRpcTransmitPacketCaseBuilder setNxEncap(NxEncap value)

addAugmentation

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

removeAugmentation

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

build

public NxActionEncapRpcTransmitPacketCase build()

Specified by:

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