org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.src.choice.grouping.src.choice

Class SrcNxTunIdCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.src.choice.grouping.src.choice.SrcNxTunIdCaseBuilder

All Implemented Interfaces:

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

public class SrcNxTunIdCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SrcNxTunIdCase>

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

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

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

SrcNxTunIdCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SrcNxTunIdCaseBuilder()
SrcNxTunIdCaseBuilder(NxmNxTunIdGrouping arg)
SrcNxTunIdCaseBuilder(SrcNxTunIdCase base)

Method Summary

Modifier and Type	Method and Description
SrcNxTunIdCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxTunIdCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxTunIdCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxTunIdCase>> E$$	augmentation(Class<E$$> augmentationType)
SrcNxTunIdCase	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Boolean	isNxTunId()
SrcNxTunIdCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxTunIdCase>> augmentationType)
SrcNxTunIdCaseBuilder	setNxTunId(Boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SrcNxTunIdCaseBuilder

public SrcNxTunIdCaseBuilder()

SrcNxTunIdCaseBuilder

public SrcNxTunIdCaseBuilder(NxmNxTunIdGrouping arg)

SrcNxTunIdCaseBuilder

public SrcNxTunIdCaseBuilder(SrcNxTunIdCase 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.NxmNxTunIdGrouping

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

isNxTunId

public Boolean isNxTunId()

augmentation

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

setNxTunId

public SrcNxTunIdCaseBuilder setNxTunId(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public SrcNxTunIdCase build()

Specified by:

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