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