Class RedirectAs4ExtendedCommunityCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.update.attributes.extended.communities.extended.community.RedirectAs4ExtendedCommunityCaseBuilder
@Generated("mdsal-binding-generator")
public class RedirectAs4ExtendedCommunityCaseBuilder
extends Object
Class that builds
RedirectAs4ExtendedCommunityCase
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:
RedirectAs4ExtendedCommunityCase createRedirectAs4ExtendedCommunityCase(int fooXyzzy, int barBaz) {
return new RedirectAs4ExtendedCommunityCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of RedirectAs4ExtendedCommunityCase, 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 new builder initialized from specifiedRedirectAs4ExtendedCommunity
.Construct a builder initialized with state from specifiedRedirectAs4ExtendedCommunityCase
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4ExtendedCommunityCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4ExtendedCommunityCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull RedirectAs4ExtendedCommunityCase
build()
A newRedirectAs4ExtendedCommunityCase
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toRedirectAs4ExtendedCommunity.getRedirectAs4()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4ExtendedCommunityCase>> augmentationType) Remove an augmentation from this builder's product.setRedirectAs4
(RedirectAs4 value) Set the property corresponding toRedirectAs4ExtendedCommunity.getRedirectAs4()
to the specified value.
-
Constructor Details
-
RedirectAs4ExtendedCommunityCaseBuilder
public RedirectAs4ExtendedCommunityCaseBuilder()Construct an empty builder. -
RedirectAs4ExtendedCommunityCaseBuilder
Construct a new builder initialized from specifiedRedirectAs4ExtendedCommunity
.- Parameters:
arg
- RedirectAs4ExtendedCommunity from which the builder should be initialized
-
RedirectAs4ExtendedCommunityCaseBuilder
Construct a builder initialized with state from specifiedRedirectAs4ExtendedCommunityCase
.- Parameters:
base
- RedirectAs4ExtendedCommunityCase from which the builder should be initialized
-
-
Method Details
-
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
-
getRedirectAs4
Return current value associated with the property corresponding toRedirectAs4ExtendedCommunity.getRedirectAs4()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4ExtendedCommunityCase>> 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
-
setRedirectAs4
Set the property corresponding toRedirectAs4ExtendedCommunity.getRedirectAs4()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RedirectAs4ExtendedCommunityCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4ExtendedCommunityCase> 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 RedirectAs4ExtendedCommunityCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectAs4ExtendedCommunityCase>> 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 newRedirectAs4ExtendedCommunityCase
instance.- Returns:
- A new
RedirectAs4ExtendedCommunityCase
instance.
-