Class DestinationFlowspecL3vpnIpv6Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.l3vpn.destination.ipv6.DestinationFlowspecL3vpnIpv6Builder
-
@Generated("mdsal-binding-generator") public class DestinationFlowspecL3vpnIpv6Builder extends Object
Class that buildsDestinationFlowspecL3vpnIpv6
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:
DestinationFlowspecL3vpnIpv6 createDestinationFlowspecL3vpnIpv6(int fooXyzzy, int barBaz) { return new DestinationFlowspecL3vpnIpv6Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DestinationFlowspecL3vpnIpv6, 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:
DestinationFlowspecL3vpnIpv6
- 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 DestinationFlowspecL3vpnIpv6Builder()
Construct an empty builder.DestinationFlowspecL3vpnIpv6Builder(DestinationFlowspecL3vpnIpv6 base)
Construct a builder initialized with state from specifiedDestinationFlowspecL3vpnIpv6
.DestinationFlowspecL3vpnIpv6Builder(FlowspecDestination arg)
Construct a new builder initialized from specifiedFlowspecDestination
.DestinationFlowspecL3vpnIpv6Builder(FlowspecDestinationGroupIpv6 arg)
Construct a new builder initialized from specifiedFlowspecDestinationGroupIpv6
.DestinationFlowspecL3vpnIpv6Builder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.DestinationFlowspecL3vpnIpv6Builder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DestinationFlowspecL3vpnIpv6Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv6> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv6>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DestinationFlowspecL3vpnIpv6
build()
A newDestinationFlowspecL3vpnIpv6
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.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()
.RouteDistinguisher
getRouteDistinguisher()
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.DestinationFlowspecL3vpnIpv6Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv6>> augmentationType)
Remove an augmentation from this builder's product.DestinationFlowspecL3vpnIpv6Builder
setFlowspec(List<Flowspec> values)
Set the property corresponding toFlowspecDestination.getFlowspec()
to the specified value.DestinationFlowspecL3vpnIpv6Builder
setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.DestinationFlowspecL3vpnIpv6Builder
setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.
-
-
-
Constructor Detail
-
DestinationFlowspecL3vpnIpv6Builder
public DestinationFlowspecL3vpnIpv6Builder()
Construct an empty builder.
-
DestinationFlowspecL3vpnIpv6Builder
public DestinationFlowspecL3vpnIpv6Builder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.- Parameters:
arg
- RouteDistinguisherGrouping from which the builder should be initialized
-
DestinationFlowspecL3vpnIpv6Builder
public DestinationFlowspecL3vpnIpv6Builder(FlowspecDestinationGroupIpv6 arg)
Construct a new builder initialized from specifiedFlowspecDestinationGroupIpv6
.- Parameters:
arg
- FlowspecDestinationGroupIpv6 from which the builder should be initialized
-
DestinationFlowspecL3vpnIpv6Builder
public DestinationFlowspecL3vpnIpv6Builder(FlowspecDestination arg)
Construct a new builder initialized from specifiedFlowspecDestination
.- Parameters:
arg
- FlowspecDestination from which the builder should be initialized
-
DestinationFlowspecL3vpnIpv6Builder
public DestinationFlowspecL3vpnIpv6Builder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
DestinationFlowspecL3vpnIpv6Builder
public DestinationFlowspecL3vpnIpv6Builder(DestinationFlowspecL3vpnIpv6 base)
Construct a builder initialized with state from specifiedDestinationFlowspecL3vpnIpv6
.- Parameters:
base
- DestinationFlowspecL3vpnIpv6 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
-
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
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv6>> 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
-
setFlowspec
public DestinationFlowspecL3vpnIpv6Builder setFlowspec(List<Flowspec> values)
Set the property corresponding toFlowspecDestination.getFlowspec()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setPathId
public DestinationFlowspecL3vpnIpv6Builder setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteDistinguisher
public DestinationFlowspecL3vpnIpv6Builder setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DestinationFlowspecL3vpnIpv6Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv6> 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 DestinationFlowspecL3vpnIpv6Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecL3vpnIpv6>> 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 DestinationFlowspecL3vpnIpv6 build()
A newDestinationFlowspecL3vpnIpv6
instance.- Returns:
- A new
DestinationFlowspecL3vpnIpv6
instance.
-
-