Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.mvpn.mvpn.choice
Class SPmsiADCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.mvpn.mvpn.choice.SPmsiADCaseBuilder
Class that builds
SPmsiADCase
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:
SPmsiADCase createSPmsiADCase(int fooXyzzy, int barBaz) {
return new SPmsiADCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SPmsiADCase, 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 specifiedSPmsiADCase
.Construct a new builder initialized from specifiedSPmsiADGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiADCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiADCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SPmsiADCase
build()
A newSPmsiADCase
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toSPmsiADGrouping.getSPmsiAD()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiADCase>> augmentationType) Remove an augmentation from this builder's product.setSPmsiAD
(SPmsiAD value) Set the property corresponding toSPmsiADGrouping.getSPmsiAD()
to the specified value.
-
Constructor Details
-
SPmsiADCaseBuilder
public SPmsiADCaseBuilder()Construct an empty builder. -
SPmsiADCaseBuilder
Construct a new builder initialized from specifiedSPmsiADGrouping
.- Parameters:
arg
- SPmsiADGrouping from which the builder should be initialized
-
SPmsiADCaseBuilder
Construct a builder initialized with state from specifiedSPmsiADCase
.- Parameters:
base
- SPmsiADCase 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
-
getSPmsiAD
Return current value associated with the property corresponding toSPmsiADGrouping.getSPmsiAD()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiADCase>> 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
-
setSPmsiAD
Set the property corresponding toSPmsiADGrouping.getSPmsiAD()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SPmsiADCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiADCase> 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 SPmsiADCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SPmsiADCase>> 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 newSPmsiADCase
instance.- Returns:
- A new
SPmsiADCase
instance.
-