Class TunIpv4DstValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.nx.match.tun.ipv4.dst.grouping.TunIpv4DstValuesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TunIpv4DstValues>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TunIpv4DstValues,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TunIpv4DstValuesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TunIpv4DstValues>
Class that buildsTunIpv4DstValuesBuilder
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:
TunIpv4DstValuesBuilder createTarget(int fooXyzzy, int barBaz) { return new TunIpv4DstValuesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunIpv4DstValuesBuilder, 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:
TunIpv4DstValuesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunIpv4DstValuesBuilder()
TunIpv4DstValuesBuilder(TunIpv4DstValues base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TunIpv4DstValuesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.TunIpv4DstValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues>>
E$$augmentation(Class<E$$> augmentationType)
TunIpv4DstValues
build()
org.opendaylight.yangtools.yang.common.Uint32
getValue()
TunIpv4DstValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues>> augmentationType)
Remove an augmentation from this builder's product.TunIpv4DstValuesBuilder
setValue(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint32)
instead.TunIpv4DstValuesBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
TunIpv4DstValuesBuilder
public TunIpv4DstValuesBuilder()
-
TunIpv4DstValuesBuilder
public TunIpv4DstValuesBuilder(TunIpv4DstValues base)
-
-
Method Detail
-
getValue
public org.opendaylight.yangtools.yang.common.Uint32 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues>> E$$ augmentation(Class<E$$> augmentationType)
-
setValue
public TunIpv4DstValuesBuilder setValue(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setValue
@Deprecated(forRemoval=true) public TunIpv4DstValuesBuilder setValue(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public TunIpv4DstValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public TunIpv4DstValuesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public TunIpv4DstValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunIpv4DstValues>> 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 TunIpv4DstValues build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TunIpv4DstValues>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TunIpv4DstValues,IllegalArgumentException>
-
-