Class MvpnDestinationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.ipv4.rev180417.mvpn.destination.MvpnDestinationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MvpnDestination>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MvpnDestination,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MvpnDestinationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MvpnDestination>
Class that buildsMvpnDestination
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:
MvpnDestination createMvpnDestination(int fooXyzzy, int barBaz) { return new MvpnDestinationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MvpnDestination, 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:
MvpnDestination
,Builder
-
-
Constructor Summary
Constructors Constructor Description MvpnDestinationBuilder()
MvpnDestinationBuilder(PathIdGrouping arg)
MvpnDestinationBuilder(MvpnDestination base)
MvpnDestinationBuilder(Mvpn arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MvpnDestinationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MvpnDestination> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnDestination>>
E$$augmentation(Class<E$$> augmentationType)
MvpnDestination
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MvpnChoice
getMvpnChoice()
PathId
getPathId()
MvpnDestinationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnDestination>> augmentationType)
Remove an augmentation from this builder's product.MvpnDestinationBuilder
setMvpnChoice(MvpnChoice value)
MvpnDestinationBuilder
setPathId(PathId value)
-
-
-
Constructor Detail
-
MvpnDestinationBuilder
public MvpnDestinationBuilder()
-
MvpnDestinationBuilder
public MvpnDestinationBuilder(Mvpn arg)
-
MvpnDestinationBuilder
public MvpnDestinationBuilder(PathIdGrouping arg)
-
MvpnDestinationBuilder
public MvpnDestinationBuilder(MvpnDestination 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:- Mvpn
- PathIdGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMvpnChoice
public MvpnChoice getMvpnChoice()
-
getPathId
public PathId getPathId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnDestination>> E$$ augmentation(Class<E$$> augmentationType)
-
setMvpnChoice
public MvpnDestinationBuilder setMvpnChoice(MvpnChoice value)
-
setPathId
public MvpnDestinationBuilder setPathId(PathId value)
-
addAugmentation
public MvpnDestinationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MvpnDestination> 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 MvpnDestinationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnDestination>> 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 MvpnDestination build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MvpnDestination>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MvpnDestination,IllegalArgumentException>
-
-