org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.tcp.dst.grouping

Class NxmOfTcpDstBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.tcp.dst.grouping.NxmOfTcpDstBuilder

All Implemented Interfaces:

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

public class NxmOfTcpDstBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmOfTcpDst>

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

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

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

NxmOfTcpDstBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmOfTcpDstBuilder()
NxmOfTcpDstBuilder(NxmOfTcpDst base)

Method Summary

Modifier and Type	Method and Description
NxmOfTcpDstBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfTcpDst>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfTcpDst> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfTcpDst>> E$$	augmentation(Class<E$$> augmentationType)
NxmOfTcpDst	build()
Integer	getMask()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber	getPort()
NxmOfTcpDstBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfTcpDst>> augmentationType)
NxmOfTcpDstBuilder	setMask(Integer value)
NxmOfTcpDstBuilder	setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmOfTcpDstBuilder

public NxmOfTcpDstBuilder()

NxmOfTcpDstBuilder

public NxmOfTcpDstBuilder(NxmOfTcpDst base)

Method Detail

getMask

public Integer getMask()

getPort

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()

augmentation

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

setMask

public NxmOfTcpDstBuilder setMask(Integer value)

setPort

public NxmOfTcpDstBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)

addAugmentation

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

removeAugmentation

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

build

public NxmOfTcpDst build()

Specified by:

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