Class TunnelIdBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.tunnel.id._case.TunnelIdBuilder
-
@Generated("mdsal-binding-generator") public class TunnelIdBuilder extends Object
Class that buildsTunnelId
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:
TunnelId createTunnelId(int fooXyzzy, int barBaz) { return new TunnelIdBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelId, 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:
TunnelId
- 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
-
-
Constructor Summary
Constructors Constructor Description TunnelIdBuilder()
Construct an empty builder.TunnelIdBuilder(TunnelId base)
Construct a builder initialized with state from specifiedTunnelId
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TunnelIdBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelId> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelId>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TunnelId
build()
A newTunnelId
instance.byte[]
getMask()
Return current value associated with the property corresponding toTunnelId.getMask()
.byte[]
getTunnelId()
Return current value associated with the property corresponding toTunnelId.getTunnelId()
.TunnelIdBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelId>> augmentationType)
Remove an augmentation from this builder's product.TunnelIdBuilder
setMask(byte[] value)
Set the property corresponding toTunnelId.getMask()
to the specified value.TunnelIdBuilder
setTunnelId(byte[] value)
Set the property corresponding toTunnelId.getTunnelId()
to the specified value.
-
-
-
Method Detail
-
getMask
public byte[] getMask()
Return current value associated with the property corresponding toTunnelId.getMask()
.- Returns:
- current value
-
getTunnelId
public byte[] getTunnelId()
Return current value associated with the property corresponding toTunnelId.getTunnelId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelId>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setMask
public TunnelIdBuilder setMask(byte[] value)
Set the property corresponding toTunnelId.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTunnelId
public TunnelIdBuilder setTunnelId(byte[] value)
Set the property corresponding toTunnelId.getTunnelId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TunnelIdBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelId> 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 TunnelIdBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelId>> 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
-
-