Class Ipv6ExtHeaderBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ipv6.match.fields.Ipv6ExtHeaderBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv6ExtHeader>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6ExtHeader,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv6ExtHeaderBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv6ExtHeader>
Class that buildsIpv6ExtHeader
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:
Ipv6ExtHeader createIpv6ExtHeader(int fooXyzzy, int barBaz) { return new Ipv6ExtHeaderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6ExtHeader, 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:
Ipv6ExtHeader
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv6ExtHeaderBuilder()
Ipv6ExtHeaderBuilder(Ipv6ExtHeader base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6ExtHeaderBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6ExtHeader> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6ExtHeader>>
E$$augmentation(Class<E$$> augmentationType)
Ipv6ExtHeader
build()
org.opendaylight.yangtools.yang.common.Uint16
getIpv6Exthdr()
org.opendaylight.yangtools.yang.common.Uint16
getIpv6ExthdrMask()
Ipv6ExtHeaderBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6ExtHeader>> augmentationType)
Remove an augmentation from this builder's product.Ipv6ExtHeaderBuilder
setIpv6Exthdr(org.opendaylight.yangtools.yang.common.Uint16 value)
Ipv6ExtHeaderBuilder
setIpv6ExthdrMask(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
Ipv6ExtHeaderBuilder
public Ipv6ExtHeaderBuilder()
-
Ipv6ExtHeaderBuilder
public Ipv6ExtHeaderBuilder(Ipv6ExtHeader base)
-
-
Method Detail
-
getIpv6Exthdr
public org.opendaylight.yangtools.yang.common.Uint16 getIpv6Exthdr()
-
getIpv6ExthdrMask
public org.opendaylight.yangtools.yang.common.Uint16 getIpv6ExthdrMask()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6ExtHeader>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpv6Exthdr
public Ipv6ExtHeaderBuilder setIpv6Exthdr(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIpv6ExthdrMask
public Ipv6ExtHeaderBuilder setIpv6ExthdrMask(org.opendaylight.yangtools.yang.common.Uint16 value)
-
addAugmentation
public Ipv6ExtHeaderBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6ExtHeader> 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 Ipv6ExtHeaderBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6ExtHeader>> 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 Ipv6ExtHeader build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv6ExtHeader>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6ExtHeader,IllegalArgumentException>
-
-