org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.encap.grouping

Class NxEncapBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.encap.grouping.NxEncapBuilder

All Implemented Interfaces:

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

public class NxEncapBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxEncap>

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

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

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

NxEncapBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxEncapBuilder()
NxEncapBuilder(NxEncap base)
NxEncapBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.PacketTypeFields arg)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NxEncapBuilder

public NxEncapBuilder()

NxEncapBuilder

public NxEncapBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.PacketTypeFields arg)

NxEncapBuilder

public NxEncapBuilder(NxEncap 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.model.match.types.rev131026.PacketTypeFields

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getPacketType

public Long getPacketType()

augmentation

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

setPacketType

public NxEncapBuilder setPacketType(Long value)

addAugmentation

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

removeAugmentation

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

build

public NxEncap build()

Specified by:

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