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