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