Class RouteTargetIpv4CaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.RouteTargetIpv4CaseBuilder
Class that builds
RouteTargetIpv4Case
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:
RouteTargetIpv4Case createRouteTargetIpv4Case(int fooXyzzy, int barBaz) {
return new RouteTargetIpv4CaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of RouteTargetIpv4Case, 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
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedRouteTargetIpv4Case
.Construct a new builder initialized from specifiedRouteTargetIpv4Grouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<RouteTargetIpv4Case> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<RouteTargetIpv4Case>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull RouteTargetIpv4Case
build()
A newRouteTargetIpv4Case
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toRouteTargetIpv4Grouping.getRouteTargetIpv4()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<RouteTargetIpv4Case>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toRouteTargetIpv4Grouping.getRouteTargetIpv4()
to the specified value.
-
Constructor Details
-
RouteTargetIpv4CaseBuilder
public RouteTargetIpv4CaseBuilder()Construct an empty builder. -
RouteTargetIpv4CaseBuilder
Construct a new builder initialized from specifiedRouteTargetIpv4Grouping
.- Parameters:
arg
- RouteTargetIpv4Grouping from which the builder should be initialized
-
RouteTargetIpv4CaseBuilder
Construct a builder initialized with state from specifiedRouteTargetIpv4Case
.- Parameters:
base
- RouteTargetIpv4Case from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
getRouteTargetIpv4
Return current value associated with the property corresponding toRouteTargetIpv4Grouping.getRouteTargetIpv4()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<RouteTargetIpv4Case>> 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
-
setRouteTargetIpv4
Set the property corresponding toRouteTargetIpv4Grouping.getRouteTargetIpv4()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RouteTargetIpv4CaseBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<RouteTargetIpv4Case> 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 RouteTargetIpv4CaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<RouteTargetIpv4Case>> 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
A newRouteTargetIpv4Case
instance.- Returns:
- A new
RouteTargetIpv4Case
instance.
-