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

Class NxmOfTcpSrcBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class NxmOfTcpSrcBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmOfTcpSrc>

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

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

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

NxmOfTcpSrcBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmOfTcpSrcBuilder()
NxmOfTcpSrcBuilder(NxmOfTcpSrc base)

Method Summary

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

NxmOfTcpSrcBuilder

public NxmOfTcpSrcBuilder()

NxmOfTcpSrcBuilder

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

setMask

public NxmOfTcpSrcBuilder setMask(Integer value)

setPort

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

addAugmentation

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

removeAugmentation

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

build

public NxmOfTcpSrc build()

Specified by:

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