Class MvpnRoutesIpv4CaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.ipv4.rev180417.bgp.rib.rib.loc.rib.tables.routes.MvpnRoutesIpv4CaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MvpnRoutesIpv4Case>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MvpnRoutesIpv4Case,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MvpnRoutesIpv4CaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MvpnRoutesIpv4Case>
Class that buildsMvpnRoutesIpv4CaseBuilder
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:
MvpnRoutesIpv4CaseBuilder createTarget(int fooXyzzy, int barBaz) { return new MvpnRoutesIpv4CaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MvpnRoutesIpv4CaseBuilder, 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 oportunities, 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:
MvpnRoutesIpv4CaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MvpnRoutesIpv4CaseBuilder()
MvpnRoutesIpv4CaseBuilder(MvpnRoutesIpv4Case base)
MvpnRoutesIpv4CaseBuilder(MvpnRoutesIpv4 arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MvpnRoutesIpv4CaseBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.MvpnRoutesIpv4CaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case>>
E$$augmentation(Class<E$$> augmentationType)
MvpnRoutesIpv4Case
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MvpnRoutesIpv4
getMvpnRoutesIpv4()
MvpnRoutesIpv4CaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case>> augmentationType)
Remove an augmentation from this builder's product.MvpnRoutesIpv4CaseBuilder
setMvpnRoutesIpv4(MvpnRoutesIpv4 value)
-
-
-
Constructor Detail
-
MvpnRoutesIpv4CaseBuilder
public MvpnRoutesIpv4CaseBuilder()
-
MvpnRoutesIpv4CaseBuilder
public MvpnRoutesIpv4CaseBuilder(MvpnRoutesIpv4 arg)
-
MvpnRoutesIpv4CaseBuilder
public MvpnRoutesIpv4CaseBuilder(MvpnRoutesIpv4Case base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.ipv4.rev180417.MvpnRoutesIpv4
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getMvpnRoutesIpv4
public MvpnRoutesIpv4 getMvpnRoutesIpv4()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case>> E$$ augmentation(Class<E$$> augmentationType)
-
setMvpnRoutesIpv4
public MvpnRoutesIpv4CaseBuilder setMvpnRoutesIpv4(MvpnRoutesIpv4 value)
-
addAugmentation
public MvpnRoutesIpv4CaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public MvpnRoutesIpv4CaseBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public MvpnRoutesIpv4CaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoutesIpv4Case>> 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 MvpnRoutesIpv4Case build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MvpnRoutesIpv4Case>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MvpnRoutesIpv4Case,IllegalArgumentException>
-
-