Class TlvsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.stat.TlvsBuilder
Class that builds
Tlvs
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:
Tlvs createTlvs(int fooXyzzy, int barBaz) {
return new TlvsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Tlvs, 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.TlvsBuilder
(Tlvs base) Construct a builder initialized with state from specifiedTlvs
.TlvsBuilder
(StatTlvs arg) Construct a new builder initialized from specifiedStatTlvs
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Tlvs
build()
A newTlvs
instance.static @NonNull Tlvs
empty()
Get empty instance of Tlvs.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toStatTlvs.getAdjRibsInRoutesTlv()
.Return current value associated with the property corresponding toStatTlvs.getDuplicatePrefixAdvertisementsTlv()
.Return current value associated with the property corresponding toStatTlvs.getDuplicateUpdatesTlv()
.Return current value associated with the property corresponding toStatTlvs.getDuplicateWithdrawsTlv()
.Return current value associated with the property corresponding toStatTlvs.getInvalidatedAsConfedLoopTlv()
.Return current value associated with the property corresponding toStatTlvs.getInvalidatedAsPathLoopTlv()
.Return current value associated with the property corresponding toStatTlvs.getInvalidatedClusterListLoopTlv()
.Return current value associated with the property corresponding toStatTlvs.getInvalidatedOriginatorIdTlv()
.Return current value associated with the property corresponding toStatTlvs.getLocRibRoutesTlv()
.Return current value associated with the property corresponding toStatTlvs.getPerAfiSafiAdjRibInTlv()
.Return current value associated with the property corresponding toStatTlvs.getPerAfiSafiLocRibTlv()
.Return current value associated with the property corresponding toStatTlvs.getPrefixesTreatedAsWithdrawTlv()
.Return current value associated with the property corresponding toStatTlvs.getRejectedPrefixesTlv()
.Return current value associated with the property corresponding toStatTlvs.getUpdatesTreatedAsWithdrawTlv()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toStatTlvs.getAdjRibsInRoutesTlv()
to the specified value.Set the property corresponding toStatTlvs.getDuplicatePrefixAdvertisementsTlv()
to the specified value.Set the property corresponding toStatTlvs.getDuplicateUpdatesTlv()
to the specified value.Set the property corresponding toStatTlvs.getDuplicateWithdrawsTlv()
to the specified value.Set the property corresponding toStatTlvs.getInvalidatedAsConfedLoopTlv()
to the specified value.Set the property corresponding toStatTlvs.getInvalidatedAsPathLoopTlv()
to the specified value.Set the property corresponding toStatTlvs.getInvalidatedClusterListLoopTlv()
to the specified value.Set the property corresponding toStatTlvs.getInvalidatedOriginatorIdTlv()
to the specified value.Set the property corresponding toStatTlvs.getLocRibRoutesTlv()
to the specified value.Set the property corresponding toStatTlvs.getPerAfiSafiAdjRibInTlv()
to the specified value.Set the property corresponding toStatTlvs.getPerAfiSafiLocRibTlv()
to the specified value.Set the property corresponding toStatTlvs.getPrefixesTreatedAsWithdrawTlv()
to the specified value.Set the property corresponding toStatTlvs.getRejectedPrefixesTlv()
to the specified value.Set the property corresponding toStatTlvs.getUpdatesTreatedAsWithdrawTlv()
to the specified value.
-
Constructor Details
-
TlvsBuilder
public TlvsBuilder()Construct an empty builder. -
TlvsBuilder
Construct a new builder initialized from specifiedStatTlvs
.- Parameters:
arg
- StatTlvs from which the builder should be initialized
-
TlvsBuilder
Construct a builder initialized with state from specifiedTlvs
.- Parameters:
base
- Tlvs 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 Tlvs.- Returns:
- An empty
Tlvs
-
getAdjRibsInRoutesTlv
Return current value associated with the property corresponding toStatTlvs.getAdjRibsInRoutesTlv()
.- Returns:
- current value
-
getDuplicatePrefixAdvertisementsTlv
Return current value associated with the property corresponding toStatTlvs.getDuplicatePrefixAdvertisementsTlv()
.- Returns:
- current value
-
getDuplicateUpdatesTlv
Return current value associated with the property corresponding toStatTlvs.getDuplicateUpdatesTlv()
.- Returns:
- current value
-
getDuplicateWithdrawsTlv
Return current value associated with the property corresponding toStatTlvs.getDuplicateWithdrawsTlv()
.- Returns:
- current value
-
getInvalidatedAsConfedLoopTlv
Return current value associated with the property corresponding toStatTlvs.getInvalidatedAsConfedLoopTlv()
.- Returns:
- current value
-
getInvalidatedAsPathLoopTlv
Return current value associated with the property corresponding toStatTlvs.getInvalidatedAsPathLoopTlv()
.- Returns:
- current value
-
getInvalidatedClusterListLoopTlv
Return current value associated with the property corresponding toStatTlvs.getInvalidatedClusterListLoopTlv()
.- Returns:
- current value
-
getInvalidatedOriginatorIdTlv
Return current value associated with the property corresponding toStatTlvs.getInvalidatedOriginatorIdTlv()
.- Returns:
- current value
-
getLocRibRoutesTlv
Return current value associated with the property corresponding toStatTlvs.getLocRibRoutesTlv()
.- Returns:
- current value
-
getPerAfiSafiAdjRibInTlv
Return current value associated with the property corresponding toStatTlvs.getPerAfiSafiAdjRibInTlv()
.- Returns:
- current value
-
getPerAfiSafiLocRibTlv
Return current value associated with the property corresponding toStatTlvs.getPerAfiSafiLocRibTlv()
.- Returns:
- current value
-
getPrefixesTreatedAsWithdrawTlv
Return current value associated with the property corresponding toStatTlvs.getPrefixesTreatedAsWithdrawTlv()
.- Returns:
- current value
-
getRejectedPrefixesTlv
Return current value associated with the property corresponding toStatTlvs.getRejectedPrefixesTlv()
.- Returns:
- current value
-
getUpdatesTreatedAsWithdrawTlv
Return current value associated with the property corresponding toStatTlvs.getUpdatesTreatedAsWithdrawTlv()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs>> 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
-
setAdjRibsInRoutesTlv
Set the property corresponding toStatTlvs.getAdjRibsInRoutesTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDuplicatePrefixAdvertisementsTlv
Set the property corresponding toStatTlvs.getDuplicatePrefixAdvertisementsTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDuplicateUpdatesTlv
Set the property corresponding toStatTlvs.getDuplicateUpdatesTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDuplicateWithdrawsTlv
Set the property corresponding toStatTlvs.getDuplicateWithdrawsTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInvalidatedAsConfedLoopTlv
Set the property corresponding toStatTlvs.getInvalidatedAsConfedLoopTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInvalidatedAsPathLoopTlv
Set the property corresponding toStatTlvs.getInvalidatedAsPathLoopTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInvalidatedClusterListLoopTlv
Set the property corresponding toStatTlvs.getInvalidatedClusterListLoopTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInvalidatedOriginatorIdTlv
Set the property corresponding toStatTlvs.getInvalidatedOriginatorIdTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocRibRoutesTlv
Set the property corresponding toStatTlvs.getLocRibRoutesTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPerAfiSafiAdjRibInTlv
Set the property corresponding toStatTlvs.getPerAfiSafiAdjRibInTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPerAfiSafiLocRibTlv
Set the property corresponding toStatTlvs.getPerAfiSafiLocRibTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefixesTreatedAsWithdrawTlv
Set the property corresponding toStatTlvs.getPrefixesTreatedAsWithdrawTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRejectedPrefixesTlv
Set the property corresponding toStatTlvs.getRejectedPrefixesTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUpdatesTreatedAsWithdrawTlv
Set the property corresponding toStatTlvs.getUpdatesTreatedAsWithdrawTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public TlvsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs> 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 TlvsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs>> 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 newTlvs
instance.- Returns:
- A new
Tlvs
instance.
-