Class PduUpdateTlvBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.mirror.pdu.tlvs.PduUpdateTlvBuilder
-
@Generated("mdsal-binding-generator") public class PduUpdateTlvBuilder extends Object
Class that buildsPduUpdateTlv
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:
PduUpdateTlv createPduUpdateTlv(int fooXyzzy, int barBaz) { return new PduUpdateTlvBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PduUpdateTlv, 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:
PduUpdateTlv
- 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
-
-
Constructor Summary
Constructors Constructor Description PduUpdateTlvBuilder()
Construct an empty builder.PduUpdateTlvBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.PduUpdateTlvBuilder(UpdateMessage arg)
Construct a new builder initialized from specifiedUpdateMessage
.PduUpdateTlvBuilder(PduUpdateTlv base)
Construct a builder initialized with state from specifiedPduUpdateTlv
.PduUpdateTlvBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PduUpdateTlvBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PduUpdateTlv> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PduUpdateTlv>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PduUpdateTlv
build()
A newPduUpdateTlv
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Attributes
getAttributes()
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.List<Nlri>
getNlri()
Return current value associated with the property corresponding toUpdateMessage.getNlri()
.List<WithdrawnRoutes>
getWithdrawnRoutes()
Return current value associated with the property corresponding toUpdateMessage.getWithdrawnRoutes()
.PduUpdateTlvBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PduUpdateTlv>> augmentationType)
Remove an augmentation from this builder's product.PduUpdateTlvBuilder
setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.PduUpdateTlvBuilder
setNlri(List<Nlri> values)
Set the property corresponding toUpdateMessage.getNlri()
to the specified value.PduUpdateTlvBuilder
setWithdrawnRoutes(List<WithdrawnRoutes> values)
Set the property corresponding toUpdateMessage.getWithdrawnRoutes()
to the specified value.
-
-
-
Constructor Detail
-
PduUpdateTlvBuilder
public PduUpdateTlvBuilder()
Construct an empty builder.
-
PduUpdateTlvBuilder
public PduUpdateTlvBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.- Parameters:
arg
- Tlv from which the builder should be initialized
-
PduUpdateTlvBuilder
public PduUpdateTlvBuilder(UpdateMessage arg)
Construct a new builder initialized from specifiedUpdateMessage
.- Parameters:
arg
- UpdateMessage from which the builder should be initialized
-
PduUpdateTlvBuilder
public PduUpdateTlvBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.- Parameters:
arg
- PathAttributes from which the builder should be initialized
-
PduUpdateTlvBuilder
public PduUpdateTlvBuilder(PduUpdateTlv base)
Construct a builder initialized with state from specifiedPduUpdateTlv
.- Parameters:
base
- PduUpdateTlv from which the builder should be initialized
-
-
Method Detail
-
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
-
getAttributes
public Attributes getAttributes()
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.- Returns:
- current value
-
getNlri
public List<Nlri> getNlri()
Return current value associated with the property corresponding toUpdateMessage.getNlri()
.- Returns:
- current value
-
getWithdrawnRoutes
public List<WithdrawnRoutes> getWithdrawnRoutes()
Return current value associated with the property corresponding toUpdateMessage.getWithdrawnRoutes()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PduUpdateTlv>> 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
-
setAttributes
public PduUpdateTlvBuilder setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNlri
public PduUpdateTlvBuilder setNlri(List<Nlri> values)
Set the property corresponding toUpdateMessage.getNlri()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setWithdrawnRoutes
public PduUpdateTlvBuilder setWithdrawnRoutes(List<WithdrawnRoutes> values)
Set the property corresponding toUpdateMessage.getWithdrawnRoutes()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public PduUpdateTlvBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PduUpdateTlv> 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 PduUpdateTlvBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PduUpdateTlv>> 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
public @NonNull PduUpdateTlv build()
A newPduUpdateTlv
instance.- Returns:
- A new
PduUpdateTlv
instance.
-
-