Class PeerUpNotificationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.PeerUpNotificationBuilder
-
@Generated("mdsal-binding-generator") public class PeerUpNotificationBuilder extends Object
Class that buildsPeerUpNotification
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:
PeerUpNotification
- 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
-
-
Constructor Summary
Constructors Constructor Description PeerUpNotificationBuilder()
Construct an empty builder.PeerUpNotificationBuilder(PeerHeader arg)
Construct a new builder initialized from specifiedPeerHeader
.PeerUpNotificationBuilder(PeerUp arg)
Construct a new builder initialized from specifiedPeerUp
.PeerUpNotificationBuilder(PeerUpNotification base)
Construct a builder initialized with state from specifiedPeerUpNotification
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PeerUpNotificationBuilder
addAugmentation(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.Information
getInformation()
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
getLocalAddress()
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
getLocalPort()
Return current value associated with the property corresponding toPeerUp.getLocalPort()
.PeerHeader
getPeerHeader()
Return current value associated with the property corresponding toPeerHeader.getPeerHeader()
.ReceivedOpen
getReceivedOpen()
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
getRemotePort()
Return current value associated with the property corresponding toPeerUp.getRemotePort()
.SentOpen
getSentOpen()
Return current value associated with the property corresponding toPeerUp.getSentOpen()
.PeerUpNotificationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerUpNotification>> augmentationType)
Remove an augmentation from this builder's product.PeerUpNotificationBuilder
setInformation(Information value)
Set the property corresponding toPeerUp.getInformation()
to the specified value.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.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.PeerUpNotificationBuilder
setPeerHeader(PeerHeader value)
Set the property corresponding toPeerHeader.getPeerHeader()
to the specified value.PeerUpNotificationBuilder
setReceivedOpen(ReceivedOpen value)
Set the property corresponding toPeerUp.getReceivedOpen()
to the specified value.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.PeerUpNotificationBuilder
setSentOpen(SentOpen value)
Set the property corresponding toPeerUp.getSentOpen()
to the specified value.
-
-
-
Constructor Detail
-
PeerUpNotificationBuilder
public PeerUpNotificationBuilder()
Construct an empty builder.
-
PeerUpNotificationBuilder
public PeerUpNotificationBuilder(PeerHeader arg)
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
public PeerUpNotificationBuilder(PeerUp arg)
Construct a new builder initialized from specifiedPeerUp
.- Parameters:
arg
- PeerUp from which the builder should be initialized
-
PeerUpNotificationBuilder
public PeerUpNotificationBuilder(PeerUpNotification base)
Construct a builder initialized with state from specifiedPeerUpNotification
.- Parameters:
base
- PeerUpNotification from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getInformation
public Information 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
public PeerHeader getPeerHeader()
Return current value associated with the property corresponding toPeerHeader.getPeerHeader()
.- Returns:
- current value
-
getReceivedOpen
public ReceivedOpen 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
public SentOpen 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
public PeerUpNotificationBuilder setInformation(Information value)
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
public PeerUpNotificationBuilder setPeerHeader(PeerHeader value)
Set the property corresponding toPeerHeader.getPeerHeader()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReceivedOpen
public PeerUpNotificationBuilder setReceivedOpen(ReceivedOpen value)
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
public PeerUpNotificationBuilder setSentOpen(SentOpen value)
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
public @NonNull PeerUpNotification build()
A newPeerUpNotification
instance.- Returns:
- A new
PeerUpNotification
instance.
-
-