Class PduOpenTlvBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.mirror.pdu.tlvs.PduOpenTlvBuilder
-
@Generated("mdsal-binding-generator") public class PduOpenTlvBuilder extends Object
Class that buildsPduOpenTlv
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:
PduOpenTlv createPduOpenTlv(int fooXyzzy, int barBaz) { return new PduOpenTlvBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PduOpenTlv, 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:
PduOpenTlv
- 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 PduOpenTlvBuilder()
Construct an empty builder.PduOpenTlvBuilder(OpenMessage arg)
Construct a new builder initialized from specifiedOpenMessage
.PduOpenTlvBuilder(PduOpenTlv base)
Construct a builder initialized with state from specifiedPduOpenTlv
.PduOpenTlvBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PduOpenTlvBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PduOpenTlv> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PduOpenTlv>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PduOpenTlv
build()
A newPduOpenTlv
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getBgpIdentifier()
Return current value associated with the property corresponding toOpenMessage.getBgpIdentifier()
.List<BgpParameters>
getBgpParameters()
Return current value associated with the property corresponding toOpenMessage.getBgpParameters()
.org.opendaylight.yangtools.yang.common.Uint16
getHoldTimer()
Return current value associated with the property corresponding toOpenMessage.getHoldTimer()
.org.opendaylight.yangtools.yang.common.Uint16
getMyAsNumber()
Return current value associated with the property corresponding toOpenMessage.getMyAsNumber()
.ProtocolVersion
getVersion()
Return current value associated with the property corresponding toOpenMessage.getVersion()
.PduOpenTlvBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PduOpenTlv>> augmentationType)
Remove an augmentation from this builder's product.PduOpenTlvBuilder
setBgpIdentifier(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
Set the property corresponding toOpenMessage.getBgpIdentifier()
to the specified value.PduOpenTlvBuilder
setBgpParameters(List<BgpParameters> values)
Set the property corresponding toOpenMessage.getBgpParameters()
to the specified value.PduOpenTlvBuilder
setHoldTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toOpenMessage.getHoldTimer()
to the specified value.PduOpenTlvBuilder
setMyAsNumber(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toOpenMessage.getMyAsNumber()
to the specified value.PduOpenTlvBuilder
setVersion(ProtocolVersion value)
Set the property corresponding toOpenMessage.getVersion()
to the specified value.
-
-
-
Constructor Detail
-
PduOpenTlvBuilder
public PduOpenTlvBuilder()
Construct an empty builder.
-
PduOpenTlvBuilder
public PduOpenTlvBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.- Parameters:
arg
- Tlv from which the builder should be initialized
-
PduOpenTlvBuilder
public PduOpenTlvBuilder(OpenMessage arg)
Construct a new builder initialized from specifiedOpenMessage
.- Parameters:
arg
- OpenMessage from which the builder should be initialized
-
PduOpenTlvBuilder
public PduOpenTlvBuilder(PduOpenTlv base)
Construct a builder initialized with state from specifiedPduOpenTlv
.- Parameters:
base
- PduOpenTlv 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
-
getBgpIdentifier
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpIdentifier()
Return current value associated with the property corresponding toOpenMessage.getBgpIdentifier()
.- Returns:
- current value
-
getBgpParameters
public List<BgpParameters> getBgpParameters()
Return current value associated with the property corresponding toOpenMessage.getBgpParameters()
.- Returns:
- current value
-
getHoldTimer
public org.opendaylight.yangtools.yang.common.Uint16 getHoldTimer()
Return current value associated with the property corresponding toOpenMessage.getHoldTimer()
.- Returns:
- current value
-
getMyAsNumber
public org.opendaylight.yangtools.yang.common.Uint16 getMyAsNumber()
Return current value associated with the property corresponding toOpenMessage.getMyAsNumber()
.- Returns:
- current value
-
getVersion
public ProtocolVersion getVersion()
Return current value associated with the property corresponding toOpenMessage.getVersion()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PduOpenTlv>> 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
-
setBgpIdentifier
public PduOpenTlvBuilder setBgpIdentifier(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
Set the property corresponding toOpenMessage.getBgpIdentifier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBgpParameters
public PduOpenTlvBuilder setBgpParameters(List<BgpParameters> values)
Set the property corresponding toOpenMessage.getBgpParameters()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setHoldTimer
public PduOpenTlvBuilder setHoldTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toOpenMessage.getHoldTimer()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMyAsNumber
public PduOpenTlvBuilder setMyAsNumber(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toOpenMessage.getMyAsNumber()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
public PduOpenTlvBuilder setVersion(ProtocolVersion value)
Set the property corresponding toOpenMessage.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PduOpenTlvBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PduOpenTlv> 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 PduOpenTlvBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PduOpenTlv>> 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 PduOpenTlv build()
A newPduOpenTlv
instance.- Returns:
- A new
PduOpenTlv
instance.
-
-