Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.up
Class SentOpenBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.up.SentOpenBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SentOpen>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SentOpen,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SentOpenBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SentOpen>
Class that buildsSentOpenBuilder
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:
SentOpenBuilder createTarget(int fooXyzzy, int barBaz) { return new SentOpenBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SentOpenBuilder, 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:
SentOpenBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SentOpenBuilder()
SentOpenBuilder(OpenMessage arg)
SentOpenBuilder(OpenMsg arg)
SentOpenBuilder(SentOpen base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SentOpenBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SentOpen> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SentOpen>>
E$$augmentation(Class<E$$> augmentationType)
SentOpen
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()
SentOpenBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SentOpen>> augmentationType)
Remove an augmentation from this builder's product.SentOpenBuilder
setBgpIdentifier(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
SentOpenBuilder
setBgpParameters(List<BgpParameters> values)
SentOpenBuilder
setHoldTimer(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHoldTimer(Uint16)
instead.SentOpenBuilder
setHoldTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
SentOpenBuilder
setMyAsNumber(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMyAsNumber(Uint16)
instead.SentOpenBuilder
setMyAsNumber(org.opendaylight.yangtools.yang.common.Uint16 value)
SentOpenBuilder
setVersion(ProtocolVersion value)
-
-
-
Constructor Detail
-
SentOpenBuilder
public SentOpenBuilder()
-
SentOpenBuilder
public SentOpenBuilder(OpenMsg arg)
-
SentOpenBuilder
public SentOpenBuilder(OpenMessage arg)
-
SentOpenBuilder
public SentOpenBuilder(SentOpen 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.bmp.message.rev200120.OpenMsg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OpenMessage
- 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<SentOpen>> E$$ augmentation(Class<E$$> augmentationType)
-
setBgpIdentifier
public SentOpenBuilder setBgpIdentifier(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setBgpParameters
public SentOpenBuilder setBgpParameters(List<BgpParameters> values)
-
setHoldTimer
public SentOpenBuilder setHoldTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHoldTimer
@Deprecated(forRemoval=true) public SentOpenBuilder 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 SentOpenBuilder setMyAsNumber(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMyAsNumber
@Deprecated(forRemoval=true) public SentOpenBuilder 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 SentOpenBuilder setVersion(ProtocolVersion value)
-
addAugmentation
public SentOpenBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SentOpen> 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 SentOpenBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SentOpen>> 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 SentOpen build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SentOpen>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SentOpen,IllegalArgumentException>
-
-