Class Ipv6PrefixesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv6.prefixes.destination.ipv6.Ipv6PrefixesBuilder
-
@Generated("mdsal-binding-generator") public class Ipv6PrefixesBuilder extends Object
Class that buildsIpv6Prefixes
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:
Ipv6Prefixes createIpv6Prefixes(int fooXyzzy, int barBaz) { return new Ipv6PrefixesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6Prefixes, 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:
Ipv6Prefixes
- 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 Ipv6PrefixesBuilder()
Construct an empty builder.Ipv6PrefixesBuilder(Ipv6Prefixes base)
Construct a builder initialized with state from specifiedIpv6Prefixes
.Ipv6PrefixesBuilder(Ipv6Prefix arg)
Construct a new builder initialized from specifiedIpv6Prefix
.Ipv6PrefixesBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6PrefixesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefixes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefixes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv6Prefixes
build()
A newIpv6Prefixes
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PathId
getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix
getPrefix()
Return current value associated with the property corresponding toIpv6Prefix.getPrefix()
.Ipv6PrefixesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefixes>> augmentationType)
Remove an augmentation from this builder's product.Ipv6PrefixesBuilder
setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.Ipv6PrefixesBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
Set the property corresponding toIpv6Prefix.getPrefix()
to the specified value.
-
-
-
Constructor Detail
-
Ipv6PrefixesBuilder
public Ipv6PrefixesBuilder()
Construct an empty builder.
-
Ipv6PrefixesBuilder
public Ipv6PrefixesBuilder(Ipv6Prefix arg)
Construct a new builder initialized from specifiedIpv6Prefix
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.Ipv6Prefix from which the builder should be initialized
-
Ipv6PrefixesBuilder
public Ipv6PrefixesBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
Ipv6PrefixesBuilder
public Ipv6PrefixesBuilder(Ipv6Prefixes base)
Construct a builder initialized with state from specifiedIpv6Prefixes
.- Parameters:
base
- Ipv6Prefixes from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getPathId
public PathId getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- Returns:
- current value
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getPrefix()
Return current value associated with the property corresponding toIpv6Prefix.getPrefix()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefixes>> 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
-
setPathId
public Ipv6PrefixesBuilder setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefix
public Ipv6PrefixesBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
Set the property corresponding toIpv6Prefix.getPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6PrefixesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefixes> 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 Ipv6PrefixesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefixes>> 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 Ipv6Prefixes build()
A newIpv6Prefixes
instance.- Returns:
- A new
Ipv6Prefixes
instance.
-
-