Class SourceIpv6PrefixCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.group.ipv6.flowspec.flowspec.type.SourceIpv6PrefixCaseBuilder
-
@Generated("mdsal-binding-generator") public class SourceIpv6PrefixCaseBuilder extends Object
Class that buildsSourceIpv6PrefixCase
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:
SourceIpv6PrefixCase createSourceIpv6PrefixCase(int fooXyzzy, int barBaz) { return new SourceIpv6PrefixCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SourceIpv6PrefixCase, 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:
SourceIpv6PrefixCase
- 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 SourceIpv6PrefixCaseBuilder()
Construct an empty builder.SourceIpv6PrefixCaseBuilder(SourceIpv6PrefixCase base)
Construct a builder initialized with state from specifiedSourceIpv6PrefixCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SourceIpv6PrefixCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourceIpv6PrefixCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceIpv6PrefixCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SourceIpv6PrefixCase
build()
A newSourceIpv6PrefixCase
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix
getSourcePrefix()
Return current value associated with the property corresponding toSourceIpv6PrefixCase.getSourcePrefix()
.SourceIpv6PrefixCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceIpv6PrefixCase>> augmentationType)
Remove an augmentation from this builder's product.SourceIpv6PrefixCaseBuilder
setSourcePrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
Set the property corresponding toSourceIpv6PrefixCase.getSourcePrefix()
to the specified value.
-
-
-
Constructor Detail
-
SourceIpv6PrefixCaseBuilder
public SourceIpv6PrefixCaseBuilder()
Construct an empty builder.
-
SourceIpv6PrefixCaseBuilder
public SourceIpv6PrefixCaseBuilder(SourceIpv6PrefixCase base)
Construct a builder initialized with state from specifiedSourceIpv6PrefixCase
.- Parameters:
base
- SourceIpv6PrefixCase from which the builder should be initialized
-
-
Method Detail
-
getSourcePrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getSourcePrefix()
Return current value associated with the property corresponding toSourceIpv6PrefixCase.getSourcePrefix()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceIpv6PrefixCase>> 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
-
setSourcePrefix
public SourceIpv6PrefixCaseBuilder setSourcePrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
Set the property corresponding toSourceIpv6PrefixCase.getSourcePrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SourceIpv6PrefixCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourceIpv6PrefixCase> 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 SourceIpv6PrefixCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceIpv6PrefixCase>> 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 SourceIpv6PrefixCase build()
A newSourceIpv6PrefixCase
instance.- Returns:
- A new
SourceIpv6PrefixCase
instance.
-
-