Class FlowspecRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.ipv4.route.FlowspecRouteBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowspecRoute>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowspecRoute,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowspecRouteBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowspecRoute>
Class that buildsFlowspecRouteBuilder
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:
FlowspecRouteBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowspecRouteBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowspecRouteBuilder, 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:
FlowspecRouteBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowspecRouteBuilder()
FlowspecRouteBuilder(BgpRibRoute arg)
FlowspecRouteBuilder(FlowspecRoute base)
FlowspecRouteBuilder(FlowspecDestination arg)
FlowspecRouteBuilder(FlowspecDestinationGroupIpv4 arg)
FlowspecRouteBuilder(FlowspecIpv4RouteList arg)
FlowspecRouteBuilder(PathAttributes arg)
FlowspecRouteBuilder(PathIdGrouping arg)
FlowspecRouteBuilder(Route arg)
-
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)
FlowspecRoute
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Attributes
getAttributes()
List<Flowspec>
getFlowspec()
PathId
getPathId()
String
getRouteKey()
FlowspecRouteKey
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)
FlowspecRouteBuilder
setFlowspec(List<Flowspec> values)
FlowspecRouteBuilder
setPathId(PathId value)
FlowspecRouteBuilder
setRouteKey(String value)
FlowspecRouteBuilder
withKey(FlowspecRouteKey key)
-
-
-
Constructor Detail
-
FlowspecRouteBuilder
public FlowspecRouteBuilder()
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(FlowspecIpv4RouteList arg)
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(FlowspecDestinationGroupIpv4 arg)
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(FlowspecDestination arg)
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(BgpRibRoute arg)
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(Route arg)
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(PathIdGrouping arg)
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(PathAttributes arg)
-
FlowspecRouteBuilder
public FlowspecRouteBuilder(FlowspecRoute 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.flowspec.rev200120.FlowspecDestinationGroupIpv4
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FlowspecRouteKey key()
-
getAttributes
public Attributes getAttributes()
-
getPathId
public PathId getPathId()
-
getRouteKey
public String getRouteKey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoute>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlowspecRouteBuilder withKey(FlowspecRouteKey key)
-
setAttributes
public FlowspecRouteBuilder setAttributes(Attributes value)
-
setFlowspec
public FlowspecRouteBuilder setFlowspec(List<Flowspec> values)
-
setPathId
public FlowspecRouteBuilder setPathId(PathId value)
-
setRouteKey
public FlowspecRouteBuilder setRouteKey(String value)
-
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 FlowspecRoute build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowspecRoute>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowspecRoute,IllegalArgumentException>
-
-