Class DestinationFlowspecIpv6Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.ipv6.DestinationFlowspecIpv6Builder
Class that builds
DestinationFlowspecIpv6
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:
DestinationFlowspecIpv6 createDestinationFlowspecIpv6(int fooXyzzy, int barBaz) {
return new DestinationFlowspecIpv6Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of DestinationFlowspecIpv6, 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 specifiedDestinationFlowspecIpv6
.Construct a new builder initialized from specifiedFlowspecDestination
.Construct a new builder initialized from specifiedPathIdGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<DestinationFlowspecIpv6> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<DestinationFlowspecIpv6>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull DestinationFlowspecIpv6
build()
A newDestinationFlowspecIpv6
instance.static @NonNull DestinationFlowspecIpv6
empty()
Get empty instance of DestinationFlowspecIpv6.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()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<DestinationFlowspecIpv6>> 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.
-
Constructor Details
-
DestinationFlowspecIpv6Builder
public DestinationFlowspecIpv6Builder()Construct an empty builder. -
DestinationFlowspecIpv6Builder
Construct a new builder initialized from specifiedFlowspecDestination
.- Parameters:
arg
- FlowspecDestination from which the builder should be initialized
-
DestinationFlowspecIpv6Builder
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
DestinationFlowspecIpv6Builder
Construct a builder initialized with state from specifiedDestinationFlowspecIpv6
.- Parameters:
base
- DestinationFlowspecIpv6 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 DestinationFlowspecIpv6.- Returns:
- An empty
DestinationFlowspecIpv6
-
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
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<DestinationFlowspecIpv6>> 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
-
addAugmentation
public DestinationFlowspecIpv6Builder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<DestinationFlowspecIpv6> 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 DestinationFlowspecIpv6Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<DestinationFlowspecIpv6>> 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 newDestinationFlowspecIpv6
instance.- Returns:
- A new
DestinationFlowspecIpv6
instance.
-