Class TrafficRateExtendedCommunityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.traffic.rate.extended.community.TrafficRateExtendedCommunityBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TrafficRateExtendedCommunity>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TrafficRateExtendedCommunity,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TrafficRateExtendedCommunityBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TrafficRateExtendedCommunity>
Class that buildsTrafficRateExtendedCommunityBuilder
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:
TrafficRateExtendedCommunityBuilder createTarget(int fooXyzzy, int barBaz) { return new TrafficRateExtendedCommunityBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TrafficRateExtendedCommunityBuilder, 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 oportunities, 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:
TrafficRateExtendedCommunityBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TrafficRateExtendedCommunityBuilder()
TrafficRateExtendedCommunityBuilder(TrafficRateExtendedCommunity base)
-
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)
TrafficRateExtendedCommunity
build()
ShortAsNumber
getInformativeAs()
Bandwidth
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)
TrafficRateExtendedCommunityBuilder
setLocalAdministrator(Bandwidth value)
-
-
-
Constructor Detail
-
TrafficRateExtendedCommunityBuilder
public TrafficRateExtendedCommunityBuilder()
-
TrafficRateExtendedCommunityBuilder
public TrafficRateExtendedCommunityBuilder(TrafficRateExtendedCommunity base)
-
-
Method Detail
-
getInformativeAs
public ShortAsNumber getInformativeAs()
-
getLocalAdministrator
public Bandwidth getLocalAdministrator()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TrafficRateExtendedCommunity>> E$$ augmentation(Class<E$$> augmentationType)
-
setInformativeAs
public TrafficRateExtendedCommunityBuilder setInformativeAs(ShortAsNumber value)
-
setLocalAdministrator
public TrafficRateExtendedCommunityBuilder setLocalAdministrator(Bandwidth value)
-
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 TrafficRateExtendedCommunity build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TrafficRateExtendedCommunity>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TrafficRateExtendedCommunity,IllegalArgumentException>
-
-