Class Ipv6LabelBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ipv6.match.fields.Ipv6LabelBuilder
Class that builds
Ipv6Label
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:
Ipv6Label createIpv6Label(int fooXyzzy, int barBaz) {
return new Ipv6LabelBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv6Label, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Ipv6LabelBuilder
(Ipv6Label base) Construct a builder initialized with state from specifiedIpv6Label
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Label> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Label>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv6Label
build()
A newIpv6Label
instance.static @NonNull Ipv6Label
empty()
Get empty instance of Ipv6Label.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel
Return current value associated with the property corresponding toIpv6Label.getFlabelMask()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel
Return current value associated with the property corresponding toIpv6Label.getIpv6Flabel()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Label>> augmentationType) Remove an augmentation from this builder's product.setFlabelMask
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel value) Set the property corresponding toIpv6Label.getFlabelMask()
to the specified value.setIpv6Flabel
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel value) Set the property corresponding toIpv6Label.getIpv6Flabel()
to the specified value.
-
Constructor Details
-
Ipv6LabelBuilder
public Ipv6LabelBuilder()Construct an empty builder. -
Ipv6LabelBuilder
Construct a builder initialized with state from specifiedIpv6Label
.- Parameters:
base
- Ipv6Label from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Ipv6Label.- Returns:
- An empty
Ipv6Label
-
getFlabelMask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel getFlabelMask()Return current value associated with the property corresponding toIpv6Label.getFlabelMask()
.- Returns:
- current value
-
getIpv6Flabel
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel getIpv6Flabel()Return current value associated with the property corresponding toIpv6Label.getIpv6Flabel()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Label>> 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
-
setFlabelMask
public Ipv6LabelBuilder setFlabelMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel value) Set the property corresponding toIpv6Label.getFlabelMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6Flabel
public Ipv6LabelBuilder setIpv6Flabel(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel value) Set the property corresponding toIpv6Label.getIpv6Flabel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6LabelBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Label> 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 Ipv6LabelBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Label>> 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
A newIpv6Label
instance.- Returns:
- A new
Ipv6Label
instance.
-