Class TrafficRateExtendedCommunityCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.bgp.rib.route.attributes.extended.communities.extended.community.TrafficRateExtendedCommunityCaseBuilder
-
@Generated("mdsal-binding-generator") public class TrafficRateExtendedCommunityCaseBuilder extends Object
Class that buildsTrafficRateExtendedCommunityCase
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:
TrafficRateExtendedCommunityCase createTrafficRateExtendedCommunityCase(int fooXyzzy, int barBaz) { return new TrafficRateExtendedCommunityCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TrafficRateExtendedCommunityCase, 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:
TrafficRateExtendedCommunityCase
- 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 TrafficRateExtendedCommunityCaseBuilder()
Construct an empty builder.TrafficRateExtendedCommunityCaseBuilder(TrafficRateExtendedCommunityCase base)
Construct a builder initialized with state from specifiedTrafficRateExtendedCommunityCase
.TrafficRateExtendedCommunityCaseBuilder(TrafficRateExtendedCommunity arg)
Construct a new builder initialized from specifiedTrafficRateExtendedCommunity
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TrafficRateExtendedCommunityCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TrafficRateExtendedCommunityCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TrafficRateExtendedCommunityCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull TrafficRateExtendedCommunityCase
build()
A newTrafficRateExtendedCommunityCase
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.TrafficRateExtendedCommunity
getTrafficRateExtendedCommunity()
Return current value associated with the property corresponding toTrafficRateExtendedCommunity.getTrafficRateExtendedCommunity()
.TrafficRateExtendedCommunityCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TrafficRateExtendedCommunityCase>> augmentationType)
Remove an augmentation from this builder's product.TrafficRateExtendedCommunityCaseBuilder
setTrafficRateExtendedCommunity(TrafficRateExtendedCommunity value)
Set the property corresponding toTrafficRateExtendedCommunity.getTrafficRateExtendedCommunity()
to the specified value.
-
-
-
Constructor Detail
-
TrafficRateExtendedCommunityCaseBuilder
public TrafficRateExtendedCommunityCaseBuilder()
Construct an empty builder.
-
TrafficRateExtendedCommunityCaseBuilder
public TrafficRateExtendedCommunityCaseBuilder(TrafficRateExtendedCommunity arg)
Construct a new builder initialized from specifiedTrafficRateExtendedCommunity
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.TrafficRateExtendedCommunity from which the builder should be initialized
-
TrafficRateExtendedCommunityCaseBuilder
public TrafficRateExtendedCommunityCaseBuilder(TrafficRateExtendedCommunityCase base)
Construct a builder initialized with state from specifiedTrafficRateExtendedCommunityCase
.- Parameters:
base
- TrafficRateExtendedCommunityCase 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
-
getTrafficRateExtendedCommunity
public TrafficRateExtendedCommunity getTrafficRateExtendedCommunity()
Return current value associated with the property corresponding toTrafficRateExtendedCommunity.getTrafficRateExtendedCommunity()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TrafficRateExtendedCommunityCase>> 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
-
setTrafficRateExtendedCommunity
public TrafficRateExtendedCommunityCaseBuilder setTrafficRateExtendedCommunity(TrafficRateExtendedCommunity value)
Set the property corresponding toTrafficRateExtendedCommunity.getTrafficRateExtendedCommunity()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TrafficRateExtendedCommunityCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TrafficRateExtendedCommunityCase> 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 TrafficRateExtendedCommunityCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TrafficRateExtendedCommunityCase>> 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 TrafficRateExtendedCommunityCase build()
A newTrafficRateExtendedCommunityCase
instance.- Returns:
- A new
TrafficRateExtendedCommunityCase
instance.
-
-