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

Class NxDecapBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class NxDecapBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxDecap>

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

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

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

NxDecapBuilder, Builder

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NxDecapBuilder

public NxDecapBuilder()

NxDecapBuilder

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

NxDecapBuilder

public NxDecapBuilder(NxDecap 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<NxDecap>> E$$ augmentation(Class<E$$> augmentationType)

setPacketType

public NxDecapBuilder setPacketType(Long value)

addAugmentation

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

removeAugmentation

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

build

public NxDecap build()

Specified by:

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