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