Class TunIpv4SrcValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.nx.match.tun.ipv4.src.grouping.TunIpv4SrcValuesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TunIpv4SrcValues>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TunIpv4SrcValues,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TunIpv4SrcValuesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TunIpv4SrcValues>
Class that buildsTunIpv4SrcValues
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:
TunIpv4SrcValues createTunIpv4SrcValues(int fooXyzzy, int barBaz) { return new TunIpv4SrcValuesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunIpv4SrcValues, 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:
TunIpv4SrcValues
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunIpv4SrcValuesBuilder()
TunIpv4SrcValuesBuilder(TunIpv4SrcValues base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TunIpv4SrcValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4SrcValues> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4SrcValues>>
E$$augmentation(Class<E$$> augmentationType)
TunIpv4SrcValues
build()
org.opendaylight.yangtools.yang.common.Uint32
getValue()
TunIpv4SrcValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4SrcValues>> augmentationType)
Remove an augmentation from this builder's product.TunIpv4SrcValuesBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
TunIpv4SrcValuesBuilder
public TunIpv4SrcValuesBuilder()
-
TunIpv4SrcValuesBuilder
public TunIpv4SrcValuesBuilder(TunIpv4SrcValues base)
-
-
Method Detail
-
getValue
public org.opendaylight.yangtools.yang.common.Uint32 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4SrcValues>> E$$ augmentation(Class<E$$> augmentationType)
-
setValue
public TunIpv4SrcValuesBuilder setValue(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public TunIpv4SrcValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4SrcValues> 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 TunIpv4SrcValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4SrcValues>> 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 TunIpv4SrcValues build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TunIpv4SrcValues>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TunIpv4SrcValues,IllegalArgumentException>
-
-