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