Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.rev180329.l3vpn.ip.route
Class VpnRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.rev180329.l3vpn.ip.route.VpnRouteBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnRoute>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnRoute,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnRouteBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<VpnRoute>
Class that buildsVpnRoute
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:
VpnRoute createVpnRoute(int fooXyzzy, int barBaz) { return new VpnRouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnRoute, 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:
VpnRoute
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnRouteBuilder()
VpnRouteBuilder(LabeledUnicast arg)
VpnRouteBuilder(PathAttributes arg)
VpnRouteBuilder(PathIdGrouping arg)
VpnRouteBuilder(Route arg)
VpnRouteBuilder(RouteDistinguisherGrouping arg)
VpnRouteBuilder(L3vpn arg)
VpnRouteBuilder(VpnRoute base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VpnRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnRoute>>
E$$augmentation(Class<E$$> augmentationType)
VpnRoute
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Attributes
getAttributes()
List<LabelStack>
getLabelStack()
PathId
getPathId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
RouteDistinguisher
getRouteDistinguisher()
String
getRouteKey()
VpnRouteKey
key()
VpnRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnRoute>> augmentationType)
Remove an augmentation from this builder's product.VpnRouteBuilder
setAttributes(Attributes value)
VpnRouteBuilder
setLabelStack(List<LabelStack> values)
VpnRouteBuilder
setPathId(PathId value)
VpnRouteBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
VpnRouteBuilder
setRouteDistinguisher(RouteDistinguisher value)
VpnRouteBuilder
setRouteKey(String value)
VpnRouteBuilder
withKey(VpnRouteKey key)
-
-
-
Constructor Detail
-
VpnRouteBuilder
public VpnRouteBuilder()
-
VpnRouteBuilder
public VpnRouteBuilder(L3vpn arg)
-
VpnRouteBuilder
public VpnRouteBuilder(LabeledUnicast arg)
-
VpnRouteBuilder
public VpnRouteBuilder(RouteDistinguisherGrouping arg)
-
VpnRouteBuilder
public VpnRouteBuilder(Route arg)
-
VpnRouteBuilder
public VpnRouteBuilder(PathIdGrouping arg)
-
VpnRouteBuilder
public VpnRouteBuilder(PathAttributes arg)
-
VpnRouteBuilder
public VpnRouteBuilder(VpnRoute 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
- L3vpn
- PathIdGrouping
- Route
- LabeledUnicast
- RouteDistinguisherGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public VpnRouteKey key()
-
getAttributes
public Attributes getAttributes()
-
getLabelStack
public List<LabelStack> getLabelStack()
-
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<VpnRoute>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public VpnRouteBuilder withKey(VpnRouteKey key)
-
setAttributes
public VpnRouteBuilder setAttributes(Attributes value)
-
setLabelStack
public VpnRouteBuilder setLabelStack(List<LabelStack> values)
-
setPathId
public VpnRouteBuilder setPathId(PathId value)
-
setPrefix
public VpnRouteBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setRouteDistinguisher
public VpnRouteBuilder setRouteDistinguisher(RouteDistinguisher value)
-
setRouteKey
public VpnRouteBuilder setRouteKey(String value)
-
addAugmentation
public VpnRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnRoute> 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 VpnRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnRoute>> 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 VpnRoute build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnRoute>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnRoute,IllegalArgumentException>
-
-