Class PduOpenTlvBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.mirror.pdu.tlvs.PduOpenTlvBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PduOpenTlv>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PduOpenTlv,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PduOpenTlvBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PduOpenTlv>
Class that buildsPduOpenTlvBuilder
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:
PduOpenTlvBuilder createTarget(int fooXyzzy, int barBaz) { return new PduOpenTlvBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PduOpenTlvBuilder, 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 oportunities, 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:
PduOpenTlvBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PduOpenTlvBuilder()
PduOpenTlvBuilder(OpenMessage arg)
PduOpenTlvBuilder(PduOpenTlv base)
PduOpenTlvBuilder(Tlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
PduOpenTlv
build()
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()
List<BgpParameters>
getBgpParameters()
org.opendaylight.yangtools.yang.common.Uint16
getHoldTimer()
org.opendaylight.yangtools.yang.common.Uint16
getMyAsNumber()
ProtocolVersion
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)
PduOpenTlvBuilder
setBgpParameters(List<BgpParameters> values)
PduOpenTlvBuilder
setHoldTimer(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHoldTimer(Uint16)
instead.PduOpenTlvBuilder
setHoldTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
PduOpenTlvBuilder
setMyAsNumber(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMyAsNumber(Uint16)
instead.PduOpenTlvBuilder
setMyAsNumber(org.opendaylight.yangtools.yang.common.Uint16 value)
PduOpenTlvBuilder
setVersion(ProtocolVersion value)
-
-
-
Constructor Detail
-
PduOpenTlvBuilder
public PduOpenTlvBuilder()
-
PduOpenTlvBuilder
public PduOpenTlvBuilder(Tlv arg)
-
PduOpenTlvBuilder
public PduOpenTlvBuilder(OpenMessage arg)
-
PduOpenTlvBuilder
public PduOpenTlvBuilder(PduOpenTlv base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OpenMessage
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.Tlv
- 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()
-
getBgpParameters
public List<BgpParameters> getBgpParameters()
-
getHoldTimer
public org.opendaylight.yangtools.yang.common.Uint16 getHoldTimer()
-
getMyAsNumber
public org.opendaylight.yangtools.yang.common.Uint16 getMyAsNumber()
-
getVersion
public ProtocolVersion getVersion()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PduOpenTlv>> E$$ augmentation(Class<E$$> augmentationType)
-
setBgpIdentifier
public PduOpenTlvBuilder setBgpIdentifier(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setBgpParameters
public PduOpenTlvBuilder setBgpParameters(List<BgpParameters> values)
-
setHoldTimer
public PduOpenTlvBuilder setHoldTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHoldTimer
@Deprecated(forRemoval=true) public PduOpenTlvBuilder setHoldTimer(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHoldTimer(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMyAsNumber
public PduOpenTlvBuilder setMyAsNumber(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMyAsNumber
@Deprecated(forRemoval=true) public PduOpenTlvBuilder setMyAsNumber(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMyAsNumber(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setVersion
public PduOpenTlvBuilder setVersion(ProtocolVersion value)
-
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 PduOpenTlv build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PduOpenTlv>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PduOpenTlv,IllegalArgumentException>
-
-