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
Class that builds
ReceivedOpen
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedOpenMessage
.Construct a builder initialized with state from specifiedReceivedOpen
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<ReceivedOpen> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<ReceivedOpen>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ReceivedOpen
build()
A newReceivedOpen
instance.static @NonNull ReceivedOpen
empty()
Get empty instance of ReceivedOpen.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
Return current value associated with the property corresponding toOpenMessage.getBgpIdentifier()
.Return current value associated with the property corresponding toOpenMessage.getBgpParameters()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toOpenMessage.getHoldTimer()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toOpenMessage.getMyAsNumber()
.Return current value associated with the property corresponding toOpenMessage.getVersion()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<ReceivedOpen>> augmentationType) Remove an augmentation from this builder's product.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.setBgpParameters
(List<BgpParameters> values) Set the property corresponding toOpenMessage.getBgpParameters()
to the specified value.setHoldTimer
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toOpenMessage.getHoldTimer()
to the specified value.setMyAsNumber
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toOpenMessage.getMyAsNumber()
to the specified value.setVersion
(ProtocolVersion value) Set the property corresponding toOpenMessage.getVersion()
to the specified value.
-
Constructor Details
-
ReceivedOpenBuilder
public ReceivedOpenBuilder()Construct an empty builder. -
ReceivedOpenBuilder
Construct a new builder initialized from specifiedOpenMessage
.- Parameters:
arg
- OpenMessage from which the builder should be initialized
-
ReceivedOpenBuilder
Construct a builder initialized with state from specifiedReceivedOpen
.- Parameters:
base
- ReceivedOpen from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
empty
Get empty instance of ReceivedOpen.- Returns:
- An empty
ReceivedOpen
-
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
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
Return current value associated with the property corresponding toOpenMessage.getVersion()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<ReceivedOpen>> 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 ReceivedOpenBuilder 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
Set the property corresponding toOpenMessage.getBgpParameters()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setHoldTimer
Set the property corresponding toOpenMessage.getHoldTimer()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMyAsNumber
Set the property corresponding toOpenMessage.getMyAsNumber()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
Set the property corresponding toOpenMessage.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ReceivedOpenBuilder addAugmentation(org.opendaylight.yangtools.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.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
A newReceivedOpen
instance.- Returns:
- A new
ReceivedOpen
instance.
-