Class FlowspecRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.ipv6.route.FlowspecRouteBuilder
-
@Generated("mdsal-binding-generator") public class FlowspecRouteBuilder extends Object
Class that buildsFlowspecRoute
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:
FlowspecRoute createFlowspecRoute(int fooXyzzy, int barBaz) { return new FlowspecRouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowspecRoute, 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:
FlowspecRoute
- 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
-
-
Constructor Summary
Constructors Constructor Description FlowspecRouteBuilder()
Construct an empty builder.FlowspecRouteBuilder(BgpRibRoute arg)
Construct a new builder initialized from specifiedBgpRibRoute
.FlowspecRouteBuilder(FlowspecRoute base)
Construct a builder initialized with state from specifiedFlowspecRoute
.FlowspecRouteBuilder(FlowspecDestination arg)
Construct a new builder initialized from specifiedFlowspecDestination
.FlowspecRouteBuilder(FlowspecDestinationGroupIpv6 arg)
Construct a new builder initialized from specifiedFlowspecDestinationGroupIpv6
.FlowspecRouteBuilder(FlowspecIpv6RouteList arg)
Construct a new builder initialized from specifiedFlowspecIpv6RouteList
.FlowspecRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.FlowspecRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.FlowspecRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowspecRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoute>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlowspecRoute
build()
A newFlowspecRoute
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Attributes
getAttributes()
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.List<Flowspec>
getFlowspec()
Return current value associated with the property corresponding toFlowspecDestination.getFlowspec()
.PathId
getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.String
getRouteKey()
Return current value associated with the property corresponding toRoute.getRouteKey()
.FlowspecRouteKey
key()
Return current value associated with the property corresponding toFlowspecRoute.key()
.FlowspecRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoute>> augmentationType)
Remove an augmentation from this builder's product.FlowspecRouteBuilder
setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.FlowspecRouteBuilder
setFlowspec(List<Flowspec> values)
Set the property corresponding toFlowspecDestination.getFlowspec()
to the specified value.FlowspecRouteBuilder
setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.FlowspecRouteBuilder
setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.FlowspecRouteBuilder
withKey(FlowspecRouteKey key)
-
-
-
Constructor Detail
-
FlowspecRouteBuilder
public FlowspecRouteBuilder()
Construct an empty builder.
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(FlowspecIpv6RouteList arg)
Construct a new builder initialized from specifiedFlowspecIpv6RouteList
.- Parameters:
arg
- FlowspecIpv6RouteList from which the builder should be initialized
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(FlowspecDestinationGroupIpv6 arg)
Construct a new builder initialized from specifiedFlowspecDestinationGroupIpv6
.- Parameters:
arg
- FlowspecDestinationGroupIpv6 from which the builder should be initialized
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(FlowspecDestination arg)
Construct a new builder initialized from specifiedFlowspecDestination
.- Parameters:
arg
- FlowspecDestination from which the builder should be initialized
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(BgpRibRoute arg)
Construct a new builder initialized from specifiedBgpRibRoute
.- Parameters:
arg
- BgpRibRoute from which the builder should be initialized
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.- Parameters:
arg
- Route from which the builder should be initialized
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.- Parameters:
arg
- PathAttributes from which the builder should be initialized
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(FlowspecRoute base)
Construct a builder initialized with state from specifiedFlowspecRoute
.- Parameters:
base
- FlowspecRoute from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FlowspecRouteKey key()
Return current value associated with the property corresponding toFlowspecRoute.key()
.- Returns:
- current value
-
getAttributes
public Attributes getAttributes()
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.- Returns:
- current value
-
getFlowspec
public List<Flowspec> getFlowspec()
Return current value associated with the property corresponding toFlowspecDestination.getFlowspec()
.- Returns:
- current value
-
getPathId
public PathId getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- Returns:
- current value
-
getRouteKey
public String getRouteKey()
Return current value associated with the property corresponding toRoute.getRouteKey()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoute>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public FlowspecRouteBuilder withKey(FlowspecRouteKey key)
-
setAttributes
public FlowspecRouteBuilder setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowspec
public FlowspecRouteBuilder setFlowspec(List<Flowspec> values)
Set the property corresponding toFlowspecDestination.getFlowspec()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setPathId
public FlowspecRouteBuilder setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteKey
public FlowspecRouteBuilder setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowspecRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoute> 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 FlowspecRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoute>> 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 @NonNull FlowspecRoute build()
A newFlowspecRoute
instance.- Returns:
- A new
FlowspecRoute
instance.
-
-