Class RouteTargetExtendedCommunityBuilder
java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<RouteTargetExtendedCommunity,RouteTargetExtendedCommunityBuilder>
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.route.target.extended.community.grouping.RouteTargetExtendedCommunityBuilder
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator")
public class RouteTargetExtendedCommunityBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<RouteTargetExtendedCommunity,RouteTargetExtendedCommunityBuilder>
Class that builds
RouteTargetExtendedCommunity 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:
RouteTargetExtendedCommunity createRouteTargetExtendedCommunity(int fooXyzzy, int barBaz) {
return new RouteTargetExtendedCommunityBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of RouteTargetExtendedCommunity, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedRouteTargetExtendedCommunity. -
Method Summary
Modifier and TypeMethodDescription@NonNull RouteTargetExtendedCommunitybuild()Returns A newRouteTargetExtendedCommunityinstance.static @NonNull RouteTargetExtendedCommunityempty()Returns an emptyRouteTargetExtendedCommunity.Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releasebyte[]Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseSet the property corresponding toRouteTargetExtendedCommunity.getGlobalAdministrator()to the specified value.setLocalAdministrator(byte[] value) Set the property corresponding toRouteTargetExtendedCommunity.getLocalAdministrator()to the specified value.Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder
addAugmentation, augmentation, augmentations, removeAugmentation
-
Constructor Details
-
RouteTargetExtendedCommunityBuilder
public RouteTargetExtendedCommunityBuilder()Construct an empty builder. -
RouteTargetExtendedCommunityBuilder
Construct a builder initialized with state from specifiedRouteTargetExtendedCommunity.- Parameters:
base- RouteTargetExtendedCommunity from which the builder should be initialized
-
-
Method Details
-
empty
Returns an emptyRouteTargetExtendedCommunity.- Returns:
- an empty
RouteTargetExtendedCommunity
-
getGlobalAdministrator
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toRouteTargetExtendedCommunity.getGlobalAdministrator().- Returns:
- current value
-
getLocalAdministrator
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toRouteTargetExtendedCommunity.getLocalAdministrator().- Returns:
- current value
-
setGlobalAdministrator
Set the property corresponding toRouteTargetExtendedCommunity.getGlobalAdministrator()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setLocalAdministrator
Set the property corresponding toRouteTargetExtendedCommunity.getLocalAdministrator()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
build
Returns A newRouteTargetExtendedCommunityinstance.- Returns:
- A new
RouteTargetExtendedCommunityinstance
-