Class BgpPrefixSidBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.BgpPrefixSidBuilder
Class that builds
BgpPrefixSid
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:
BgpPrefixSid createBgpPrefixSid(int fooXyzzy, int barBaz) {
return new BgpPrefixSidBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of BgpPrefixSid, 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 specifiedBgpPrefixSid
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<BgpPrefixSid> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<BgpPrefixSid>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull BgpPrefixSid
build()
A newBgpPrefixSid
instance.static @NonNull BgpPrefixSid
empty()
Get empty instance of BgpPrefixSid.Return current value associated with the property corresponding toBgpPrefixSid.getBgpPrefixSidTlvs()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<BgpPrefixSid>> augmentationType) Remove an augmentation from this builder's product.setBgpPrefixSidTlvs
(List<BgpPrefixSidTlvs> values) Set the property corresponding toBgpPrefixSid.getBgpPrefixSidTlvs()
to the specified value.
-
Constructor Details
-
BgpPrefixSidBuilder
public BgpPrefixSidBuilder()Construct an empty builder. -
BgpPrefixSidBuilder
Construct a builder initialized with state from specifiedBgpPrefixSid
.- Parameters:
base
- BgpPrefixSid from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of BgpPrefixSid.- Returns:
- An empty
BgpPrefixSid
-
getBgpPrefixSidTlvs
Return current value associated with the property corresponding toBgpPrefixSid.getBgpPrefixSidTlvs()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<BgpPrefixSid>> 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
-
setBgpPrefixSidTlvs
Set the property corresponding toBgpPrefixSid.getBgpPrefixSidTlvs()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public BgpPrefixSidBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<BgpPrefixSid> 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 BgpPrefixSidBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<BgpPrefixSid>> 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 newBgpPrefixSid
instance.- Returns:
- A new
BgpPrefixSid
instance.
-