Class Ipv6LabelBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ipv6.match.fields.Ipv6LabelBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv6Label>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6Label,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv6LabelBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv6Label>
Class that buildsIpv6LabelBuilder
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:
Ipv6LabelBuilder createTarget(int fooXyzzy, int barBaz) { return new Ipv6LabelBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6LabelBuilder, 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:
Ipv6LabelBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv6LabelBuilder()
Ipv6LabelBuilder(Ipv6Label base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6LabelBuilder
addAugmentation(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)
Ipv6Label
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel
getFlabelMask()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel
getIpv6Flabel()
Ipv6LabelBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Label>> augmentationType)
Remove an augmentation from this builder's product.Ipv6LabelBuilder
setFlabelMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel value)
Ipv6LabelBuilder
setIpv6Flabel(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel value)
-
-
-
Constructor Detail
-
Ipv6LabelBuilder
public Ipv6LabelBuilder()
-
Ipv6LabelBuilder
public Ipv6LabelBuilder(Ipv6Label base)
-
-
Method Detail
-
getFlabelMask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel getFlabelMask()
-
getIpv6Flabel
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel getIpv6Flabel()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Label>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlabelMask
public Ipv6LabelBuilder setFlabelMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel value)
-
setIpv6Flabel
public Ipv6LabelBuilder setIpv6Flabel(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6FlowLabel value)
-
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
public Ipv6Label build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv6Label>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6Label,IllegalArgumentException>
-
-