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