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