Class NxmNxTunIpv4SrcBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.tun.ipv4.src.grouping.NxmNxTunIpv4SrcBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxmNxTunIpv4Src>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxTunIpv4Src,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NxmNxTunIpv4SrcBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxmNxTunIpv4Src>
Class that buildsNxmNxTunIpv4Src
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:
NxmNxTunIpv4Src createNxmNxTunIpv4Src(int fooXyzzy, int barBaz) { return new NxmNxTunIpv4SrcBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxmNxTunIpv4Src, 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 opportunities, 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:
NxmNxTunIpv4Src
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxmNxTunIpv4SrcBuilder()
NxmNxTunIpv4SrcBuilder(Ipv4AddressGrouping arg)
NxmNxTunIpv4SrcBuilder(NxmNxTunIpv4Src base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxmNxTunIpv4SrcBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src>>
E$$augmentation(Class<E$$> augmentationType)
NxmNxTunIpv4Src
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
getIpv4Address()
NxmNxTunIpv4SrcBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src>> augmentationType)
Remove an augmentation from this builder's product.NxmNxTunIpv4SrcBuilder
setIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
-
-
-
Constructor Detail
-
NxmNxTunIpv4SrcBuilder
public NxmNxTunIpv4SrcBuilder()
-
NxmNxTunIpv4SrcBuilder
public NxmNxTunIpv4SrcBuilder(Ipv4AddressGrouping arg)
-
NxmNxTunIpv4SrcBuilder
public NxmNxTunIpv4SrcBuilder(NxmNxTunIpv4Src 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:- Ipv4AddressGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIpv4Address
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4Address()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpv4Address
public NxmNxTunIpv4SrcBuilder setIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
-
addAugmentation
public NxmNxTunIpv4SrcBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public NxmNxTunIpv4SrcBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunIpv4Src>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public NxmNxTunIpv4Src build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxmNxTunIpv4Src>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxTunIpv4Src,IllegalArgumentException>
-
-