Class SentBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.neighbor.state.messages.SentBuilder
Class that builds
Sent
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:
Sent createSent(int fooXyzzy, int barBaz) {
return new SentBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Sent, 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 specifiedBgpCountersMessageTypesCommon
.Construct a new builder initialized from specifiedBgpNeighborMessageCountersSentState
.SentBuilder
(Sent base) Construct a builder initialized with state from specifiedSent
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Sent> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Sent>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Sent
build()
A newSent
instance.static @NonNull Sent
empty()
Get empty instance of Sent.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toBgpCountersMessageTypesCommon.getNOTIFICATION()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toBgpCountersMessageTypesCommon.getUPDATE()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Sent>> augmentationType) Remove an augmentation from this builder's product.setNOTIFICATION
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toBgpCountersMessageTypesCommon.getNOTIFICATION()
to the specified value.setUPDATE
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toBgpCountersMessageTypesCommon.getUPDATE()
to the specified value.
-
Constructor Details
-
SentBuilder
public SentBuilder()Construct an empty builder. -
SentBuilder
Construct a new builder initialized from specifiedBgpNeighborMessageCountersSentState
.- Parameters:
arg
- BgpNeighborMessageCountersSentState from which the builder should be initialized
-
SentBuilder
Construct a new builder initialized from specifiedBgpCountersMessageTypesCommon
.- Parameters:
arg
- BgpCountersMessageTypesCommon from which the builder should be initialized
-
SentBuilder
Construct a builder initialized with state from specifiedSent
.- Parameters:
base
- Sent 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 Sent.- Returns:
- An empty
Sent
-
getNOTIFICATION
public org.opendaylight.yangtools.yang.common.Uint64 getNOTIFICATION()Return current value associated with the property corresponding toBgpCountersMessageTypesCommon.getNOTIFICATION()
.- Returns:
- current value
-
getUPDATE
public org.opendaylight.yangtools.yang.common.Uint64 getUPDATE()Return current value associated with the property corresponding toBgpCountersMessageTypesCommon.getUPDATE()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Sent>> 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
-
setNOTIFICATION
Set the property corresponding toBgpCountersMessageTypesCommon.getNOTIFICATION()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUPDATE
Set the property corresponding toBgpCountersMessageTypesCommon.getUPDATE()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SentBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Sent> 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 SentBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Sent>> 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 newSent
instance.- Returns:
- A new
Sent
instance.
-