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