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