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 buildsNxmOfTcpSrcBuilder
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 Description NxmOfTcpSrcBuilder()
NxmOfTcpSrcBuilder(NxmOfTcpSrc base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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()
org.opendaylight.yangtools.yang.common.Uint16
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)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMask(Uint16)} instead.NxmOfTcpSrcBuilder
setMask(org.opendaylight.yangtools.yang.common.Uint16 value)
NxmOfTcpSrcBuilder
setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
-
-
Constructor Detail
-
NxmOfTcpSrcBuilder
public NxmOfTcpSrcBuilder()
-
NxmOfTcpSrcBuilder
public NxmOfTcpSrcBuilder(NxmOfTcpSrc base)
-
-
Method Detail
-
getMask
public org.opendaylight.yangtools.yang.common.Uint16 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(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMask
@Deprecated(forRemoval=true) public NxmOfTcpSrcBuilder setMask(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMask(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
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 interfaceorg.opendaylight.yangtools.concepts.Builder<NxmOfTcpSrc>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxmOfTcpSrc,IllegalArgumentException>
-
-