Class TunnelBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.TunnelBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Tunnel>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Tunnel,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TunnelBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Tunnel>
Class that buildsTunnelBuilder
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:
TunnelBuilder createTarget(int fooXyzzy, int barBaz) { return new TunnelBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelBuilder, 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:
TunnelBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunnelBuilder()
TunnelBuilder(Tunnel base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TunnelBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tunnel> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnel>>
E$$augmentation(Class<E$$> augmentationType)
Tunnel
build()
org.opendaylight.yangtools.yang.common.Uint64
getTunnelId()
org.opendaylight.yangtools.yang.common.Uint64
getTunnelMask()
TunnelBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnel>> augmentationType)
Remove an augmentation from this builder's product.TunnelBuilder
setTunnelId(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTunnelId(Uint64)
instead.TunnelBuilder
setTunnelId(org.opendaylight.yangtools.yang.common.Uint64 value)
TunnelBuilder
setTunnelMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTunnelMask(Uint64)
instead.TunnelBuilder
setTunnelMask(org.opendaylight.yangtools.yang.common.Uint64 value)
-
-
-
Constructor Detail
-
TunnelBuilder
public TunnelBuilder()
-
TunnelBuilder
public TunnelBuilder(Tunnel base)
-
-
Method Detail
-
getTunnelId
public org.opendaylight.yangtools.yang.common.Uint64 getTunnelId()
-
getTunnelMask
public org.opendaylight.yangtools.yang.common.Uint64 getTunnelMask()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnel>> E$$ augmentation(Class<E$$> augmentationType)
-
setTunnelId
public TunnelBuilder setTunnelId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setTunnelId
@Deprecated(forRemoval=true) public TunnelBuilder setTunnelId(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTunnelId(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTunnelMask
public TunnelBuilder setTunnelMask(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setTunnelMask
@Deprecated(forRemoval=true) public TunnelBuilder setTunnelMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTunnelMask(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public TunnelBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tunnel> 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 TunnelBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tunnel>> 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 Tunnel build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Tunnel>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Tunnel,IllegalArgumentException>
-
-