Class L3vpnMcastRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRouteBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<L3vpnMcastRoute>
,org.opendaylight.yangtools.concepts.CheckedBuilder<L3vpnMcastRoute,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class L3vpnMcastRouteBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<L3vpnMcastRoute>
Class that buildsL3vpnMcastRouteBuilder
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:
L3vpnMcastRouteBuilder createTarget(int fooXyzzy, int barBaz) { return new L3vpnMcastRouteBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of L3vpnMcastRouteBuilder, 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:
L3vpnMcastRouteBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description L3vpnMcastRouteBuilder()
L3vpnMcastRouteBuilder(L3vpnMcastRoute base)
L3vpnMcastRouteBuilder(L3vpnMcastRoute arg)
L3vpnMcastRouteBuilder(PathAttributes arg)
L3vpnMcastRouteBuilder(PathIdGrouping arg)
L3vpnMcastRouteBuilder(Route arg)
L3vpnMcastRouteBuilder(RouteDistinguisherGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description L3vpnMcastRouteBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.L3vpnMcastRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>>
E$$augmentation(Class<E$$> augmentationType)
L3vpnMcastRoute
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Attributes
getAttributes()
PathId
getPathId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
RouteDistinguisher
getRouteDistinguisher()
String
getRouteKey()
L3vpnMcastRouteKey
key()
L3vpnMcastRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>> augmentationType)
Remove an augmentation from this builder's product.L3vpnMcastRouteBuilder
setAttributes(Attributes value)
L3vpnMcastRouteBuilder
setPathId(PathId value)
L3vpnMcastRouteBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
L3vpnMcastRouteBuilder
setRouteDistinguisher(RouteDistinguisher value)
L3vpnMcastRouteBuilder
setRouteKey(String value)
L3vpnMcastRouteBuilder
withKey(L3vpnMcastRouteKey key)
-
-
-
Constructor Detail
-
L3vpnMcastRouteBuilder
public L3vpnMcastRouteBuilder()
-
L3vpnMcastRouteBuilder
public L3vpnMcastRouteBuilder(Route arg)
-
L3vpnMcastRouteBuilder
public L3vpnMcastRouteBuilder(PathIdGrouping arg)
-
L3vpnMcastRouteBuilder
public L3vpnMcastRouteBuilder(PathAttributes arg)
-
L3vpnMcastRouteBuilder
public L3vpnMcastRouteBuilder(L3vpnMcastRoute arg)
-
L3vpnMcastRouteBuilder
public L3vpnMcastRouteBuilder(RouteDistinguisherGrouping arg)
-
L3vpnMcastRouteBuilder
public L3vpnMcastRouteBuilder(L3vpnMcastRoute 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.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.bgp.types.rev200120.RouteDistinguisherGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoute
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public L3vpnMcastRouteKey key()
-
getAttributes
public Attributes getAttributes()
-
getPathId
public PathId getPathId()
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
-
getRouteKey
public String getRouteKey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public L3vpnMcastRouteBuilder withKey(L3vpnMcastRouteKey key)
-
setAttributes
public L3vpnMcastRouteBuilder setAttributes(Attributes value)
-
setPathId
public L3vpnMcastRouteBuilder setPathId(PathId value)
-
setPrefix
public L3vpnMcastRouteBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setRouteDistinguisher
public L3vpnMcastRouteBuilder setRouteDistinguisher(RouteDistinguisher value)
-
setRouteKey
public L3vpnMcastRouteBuilder setRouteKey(String value)
-
addAugmentation
public L3vpnMcastRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute> 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 L3vpnMcastRouteBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute> 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 L3vpnMcastRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>> 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 L3vpnMcastRoute build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<L3vpnMcastRoute>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<L3vpnMcastRoute,IllegalArgumentException>
-
-