Class PeerUpNotificationBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.PeerUpNotificationBuilder
Class that builds
PeerUpNotification
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:
PeerUpNotification createPeerUpNotification(int fooXyzzy, int barBaz) {
return new PeerUpNotificationBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of PeerUpNotification, 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 specifiedPeerHeader
.Construct a new builder initialized from specifiedPeerUp
.Construct a builder initialized with state from specifiedPeerUpNotification
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull PeerUpNotification
build()
A newPeerUpNotification
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPeerUp.getInformation()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
Return current value associated with the property corresponding toPeerUp.getLocalAddress()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
Return current value associated with the property corresponding toPeerUp.getLocalPort()
.Return current value associated with the property corresponding toPeerHeader.getPeerHeader()
.Return current value associated with the property corresponding toPeerUp.getReceivedOpen()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
Return current value associated with the property corresponding toPeerUp.getRemotePort()
.Return current value associated with the property corresponding toPeerUp.getSentOpen()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification>> augmentationType) Remove an augmentation from this builder's product.setInformation
(Information value) Set the property corresponding toPeerUp.getInformation()
to the specified value.setLocalAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toPeerUp.getLocalAddress()
to the specified value.setLocalPort
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toPeerUp.getLocalPort()
to the specified value.setPeerHeader
(PeerHeader value) Set the property corresponding toPeerHeader.getPeerHeader()
to the specified value.setReceivedOpen
(ReceivedOpen value) Set the property corresponding toPeerUp.getReceivedOpen()
to the specified value.setRemotePort
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toPeerUp.getRemotePort()
to the specified value.setSentOpen
(SentOpen value) Set the property corresponding toPeerUp.getSentOpen()
to the specified value.
-
Constructor Details
-
PeerUpNotificationBuilder
public PeerUpNotificationBuilder()Construct an empty builder. -
PeerUpNotificationBuilder
Construct a new builder initialized from specifiedPeerHeader
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.PeerHeader from which the builder should be initialized
-
PeerUpNotificationBuilder
Construct a new builder initialized from specifiedPeerUp
.- Parameters:
arg
- PeerUp from which the builder should be initialized
-
PeerUpNotificationBuilder
Construct a builder initialized with state from specifiedPeerUpNotification
.- Parameters:
base
- PeerUpNotification from which the builder should be initialized
-
-
Method Details
-
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
-
getInformation
Return current value associated with the property corresponding toPeerUp.getInformation()
.- Returns:
- current value
-
getLocalAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getLocalAddress()Return current value associated with the property corresponding toPeerUp.getLocalAddress()
.- Returns:
- current value
-
getLocalPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLocalPort()Return current value associated with the property corresponding toPeerUp.getLocalPort()
.- Returns:
- current value
-
getPeerHeader
Return current value associated with the property corresponding toPeerHeader.getPeerHeader()
.- Returns:
- current value
-
getReceivedOpen
Return current value associated with the property corresponding toPeerUp.getReceivedOpen()
.- Returns:
- current value
-
getRemotePort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getRemotePort()Return current value associated with the property corresponding toPeerUp.getRemotePort()
.- Returns:
- current value
-
getSentOpen
Return current value associated with the property corresponding toPeerUp.getSentOpen()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification>> 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
-
setInformation
Set the property corresponding toPeerUp.getInformation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalAddress
public PeerUpNotificationBuilder setLocalAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toPeerUp.getLocalAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalPort
public PeerUpNotificationBuilder setLocalPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toPeerUp.getLocalPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerHeader
Set the property corresponding toPeerHeader.getPeerHeader()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReceivedOpen
Set the property corresponding toPeerUp.getReceivedOpen()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemotePort
public PeerUpNotificationBuilder setRemotePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toPeerUp.getRemotePort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSentOpen
Set the property corresponding toPeerUp.getSentOpen()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PeerUpNotificationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification> 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 PeerUpNotificationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification>> 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 newPeerUpNotification
instance.- Returns:
- A new
PeerUpNotification
instance.
-