Class LeafADBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.leaf.a.d.grouping.LeafADBuilder
Class that builds
LeafAD
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:
LeafAD createLeafAD(int fooXyzzy, int barBaz) {
return new LeafADBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of LeafAD, 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.LeafADBuilder
(LeafAD base) Construct a builder initialized with state from specifiedLeafAD
.Construct a new builder initialized from specifiedOrigRouteIpGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<LeafAD> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LeafAD>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull LeafAD
build()
A newLeafAD
instance.static @NonNull LeafAD
empty()
Get empty instance of LeafAD.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toLeafAD.getLeafADRouteKey()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
Return current value associated with the property corresponding toOrigRouteIpGrouping.getOrigRouteIp()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LeafAD>> augmentationType) Remove an augmentation from this builder's product.setLeafADRouteKey
(LeafADRouteKey value) Set the property corresponding toLeafAD.getLeafADRouteKey()
to the specified value.setOrigRouteIp
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toOrigRouteIpGrouping.getOrigRouteIp()
to the specified value.
-
Constructor Details
-
LeafADBuilder
public LeafADBuilder()Construct an empty builder. -
LeafADBuilder
Construct a new builder initialized from specifiedOrigRouteIpGrouping
.- Parameters:
arg
- OrigRouteIpGrouping from which the builder should be initialized
-
LeafADBuilder
Construct a builder initialized with state from specifiedLeafAD
.- Parameters:
base
- LeafAD from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of LeafAD.- Returns:
- An empty
LeafAD
-
getLeafADRouteKey
Return current value associated with the property corresponding toLeafAD.getLeafADRouteKey()
.- Returns:
- current value
-
getOrigRouteIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getOrigRouteIp()Return current value associated with the property corresponding toOrigRouteIpGrouping.getOrigRouteIp()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LeafAD>> 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
-
setLeafADRouteKey
Set the property corresponding toLeafAD.getLeafADRouteKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOrigRouteIp
public LeafADBuilder setOrigRouteIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toOrigRouteIpGrouping.getOrigRouteIp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LeafADBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LeafAD> 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 LeafADBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LeafAD>> 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 newLeafAD
instance.- Returns:
- A new
LeafAD
instance.
-