Class L3vpnMcastRoutesIpv4CaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.bgp.rib.rib.peer.adj.rib.out.tables.routes.L3vpnMcastRoutesIpv4CaseBuilder
Class that builds
L3vpnMcastRoutesIpv4Case
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:
L3vpnMcastRoutesIpv4Case createL3vpnMcastRoutesIpv4Case(int fooXyzzy, int barBaz) {
return new L3vpnMcastRoutesIpv4CaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of L3vpnMcastRoutesIpv4Case, 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.Construct a builder initialized with state from specifiedL3vpnMcastRoutesIpv4Case
.Construct a new builder initialized from specifiedL3vpnMcastRoutesIpv4
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv4Case> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv4Case>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull L3vpnMcastRoutesIpv4Case
build()
A newL3vpnMcastRoutesIpv4Case
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toL3vpnMcastRoutesIpv4.getL3vpnMcastRoutesIpv4()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv4Case>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toL3vpnMcastRoutesIpv4.getL3vpnMcastRoutesIpv4()
to the specified value.
-
Constructor Details
-
L3vpnMcastRoutesIpv4CaseBuilder
public L3vpnMcastRoutesIpv4CaseBuilder()Construct an empty builder. -
L3vpnMcastRoutesIpv4CaseBuilder
Construct a new builder initialized from specifiedL3vpnMcastRoutesIpv4
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoutesIpv4 from which the builder should be initialized
-
L3vpnMcastRoutesIpv4CaseBuilder
Construct a builder initialized with state from specifiedL3vpnMcastRoutesIpv4Case
.- Parameters:
base
- L3vpnMcastRoutesIpv4Case 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
-
getL3vpnMcastRoutesIpv4
Return current value associated with the property corresponding toL3vpnMcastRoutesIpv4.getL3vpnMcastRoutesIpv4()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv4Case>> 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
-
setL3vpnMcastRoutesIpv4
Set the property corresponding toL3vpnMcastRoutesIpv4.getL3vpnMcastRoutesIpv4()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public L3vpnMcastRoutesIpv4CaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv4Case> 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 L3vpnMcastRoutesIpv4CaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv4Case>> 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 newL3vpnMcastRoutesIpv4Case
instance.- Returns:
- A new
L3vpnMcastRoutesIpv4Case
instance.
-