Class Ipv6ExthdrBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.exthdr._case.Ipv6ExthdrBuilder
-
@Generated("mdsal-binding-generator") public class Ipv6ExthdrBuilder extends Object
Class that buildsIpv6Exthdr
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:
Ipv6Exthdr createIpv6Exthdr(int fooXyzzy, int barBaz) { return new Ipv6ExthdrBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6Exthdr, 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:
Ipv6Exthdr
- 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 Ipv6ExthdrBuilder()
Construct an empty builder.Ipv6ExthdrBuilder(Ipv6Exthdr base)
Construct a builder initialized with state from specifiedIpv6Exthdr
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6ExthdrBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Exthdr> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Exthdr>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv6Exthdr
build()
A newIpv6Exthdr
instance.byte[]
getMask()
Return current value associated with the property corresponding toIpv6Exthdr.getMask()
.Ipv6ExthdrFlags
getPseudoField()
Return current value associated with the property corresponding toIpv6Exthdr.getPseudoField()
.Ipv6ExthdrBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Exthdr>> augmentationType)
Remove an augmentation from this builder's product.Ipv6ExthdrBuilder
setMask(byte[] value)
Set the property corresponding toIpv6Exthdr.getMask()
to the specified value.Ipv6ExthdrBuilder
setPseudoField(Ipv6ExthdrFlags value)
Set the property corresponding toIpv6Exthdr.getPseudoField()
to the specified value.
-
-
-
Constructor Detail
-
Ipv6ExthdrBuilder
public Ipv6ExthdrBuilder()
Construct an empty builder.
-
Ipv6ExthdrBuilder
public Ipv6ExthdrBuilder(Ipv6Exthdr base)
Construct a builder initialized with state from specifiedIpv6Exthdr
.- Parameters:
base
- Ipv6Exthdr from which the builder should be initialized
-
-
Method Detail
-
getMask
public byte[] getMask()
Return current value associated with the property corresponding toIpv6Exthdr.getMask()
.- Returns:
- current value
-
getPseudoField
public Ipv6ExthdrFlags getPseudoField()
Return current value associated with the property corresponding toIpv6Exthdr.getPseudoField()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Exthdr>> 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 Ipv6ExthdrBuilder setMask(byte[] value)
Set the property corresponding toIpv6Exthdr.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPseudoField
public Ipv6ExthdrBuilder setPseudoField(Ipv6ExthdrFlags value)
Set the property corresponding toIpv6Exthdr.getPseudoField()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6ExthdrBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Exthdr> 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 Ipv6ExthdrBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Exthdr>> 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 @NonNull Ipv6Exthdr build()
A newIpv6Exthdr
instance.- Returns:
- A new
Ipv6Exthdr
instance.
-
-