Class AfiSafisBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafisBuilder
Class that builds
AfiSafis
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:
AfiSafis createAfiSafis(int fooXyzzy, int barBaz) {
return new AfiSafisBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of AfiSafis, 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 new builder initialized from specifiedBgpCommonAfiSafiList
.AfiSafisBuilder
(AfiSafis base) Construct a builder initialized with state from specifiedAfiSafis
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafis> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafis>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull AfiSafis
build()
A newAfiSafis
instance.static @NonNull AfiSafis
empty()
Get empty instance of AfiSafis.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toBgpCommonAfiSafiList.getAfiSafi()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafis>> augmentationType) Remove an augmentation from this builder's product.setAfiSafi
(Map<AfiSafiKey, AfiSafi> values) Set the property corresponding toBgpCommonAfiSafiList.getAfiSafi()
to the specified value.
-
Constructor Details
-
AfiSafisBuilder
public AfiSafisBuilder()Construct an empty builder. -
AfiSafisBuilder
Construct a new builder initialized from specifiedBgpCommonAfiSafiList
.- Parameters:
arg
- BgpCommonAfiSafiList from which the builder should be initialized
-
AfiSafisBuilder
Construct a builder initialized with state from specifiedAfiSafis
.- Parameters:
base
- AfiSafis from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject 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
-
empty
Get empty instance of AfiSafis.- Returns:
- An empty
AfiSafis
-
getAfiSafi
Return current value associated with the property corresponding toBgpCommonAfiSafiList.getAfiSafi()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafis>> 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
-
setAfiSafi
Set the property corresponding toBgpCommonAfiSafiList.getAfiSafi()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public AfiSafisBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafis> 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 AfiSafisBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AfiSafis>> 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 newAfiSafis
instance.- Returns:
- A new
AfiSafis
instance.
-