Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.peers.peer
Class PeerSessionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.peers.peer.PeerSessionBuilder
-
@Generated("mdsal-binding-generator") public class PeerSessionBuilder extends Object
Class that buildsPeerSession
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:
PeerSession createPeerSession(int fooXyzzy, int barBaz) { return new PeerSessionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerSession, 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:
PeerSession
- 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 PeerSessionBuilder()
Construct an empty builder.PeerSessionBuilder(PeerUp arg)
Construct a new builder initialized from specifiedPeerUp
.PeerSessionBuilder(Timestamp arg)
Construct a new builder initialized from specifiedTimestamp
.PeerSessionBuilder(PeerSession base)
Construct a builder initialized with state from specifiedPeerSession
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PeerSessionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerSession> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerSession>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PeerSession
build()
A newPeerSession
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()
.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()
.Status
getStatus()
Return current value associated with the property corresponding toPeerSession.getStatus()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp
getTimestampMicro()
Return current value associated with the property corresponding toTimestamp.getTimestampMicro()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp
getTimestampSec()
Return current value associated with the property corresponding toTimestamp.getTimestampSec()
.PeerSessionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerSession>> augmentationType)
Remove an augmentation from this builder's product.PeerSessionBuilder
setInformation(Information value)
Set the property corresponding toPeerUp.getInformation()
to the specified value.PeerSessionBuilder
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.PeerSessionBuilder
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.PeerSessionBuilder
setReceivedOpen(ReceivedOpen value)
Set the property corresponding toPeerUp.getReceivedOpen()
to the specified value.PeerSessionBuilder
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.PeerSessionBuilder
setSentOpen(SentOpen value)
Set the property corresponding toPeerUp.getSentOpen()
to the specified value.PeerSessionBuilder
setStatus(Status value)
Set the property corresponding toPeerSession.getStatus()
to the specified value.PeerSessionBuilder
setTimestampMicro(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
Set the property corresponding toTimestamp.getTimestampMicro()
to the specified value.PeerSessionBuilder
setTimestampSec(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
Set the property corresponding toTimestamp.getTimestampSec()
to the specified value.
-
-
-
Constructor Detail
-
PeerSessionBuilder
public PeerSessionBuilder()
Construct an empty builder.
-
PeerSessionBuilder
public PeerSessionBuilder(PeerUp arg)
Construct a new builder initialized from specifiedPeerUp
.- Parameters:
arg
- PeerUp from which the builder should be initialized
-
PeerSessionBuilder
public PeerSessionBuilder(Timestamp arg)
Construct a new builder initialized from specifiedTimestamp
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.Timestamp from which the builder should be initialized
-
PeerSessionBuilder
public PeerSessionBuilder(PeerSession base)
Construct a builder initialized with state from specifiedPeerSession
.- Parameters:
base
- PeerSession 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
-
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
-
getStatus
public Status getStatus()
Return current value associated with the property corresponding toPeerSession.getStatus()
.- Returns:
- current value
-
getTimestampMicro
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampMicro()
Return current value associated with the property corresponding toTimestamp.getTimestampMicro()
.- Returns:
- current value
-
getTimestampSec
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampSec()
Return current value associated with the property corresponding toTimestamp.getTimestampSec()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerSession>> 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 PeerSessionBuilder setInformation(Information value)
Set the property corresponding toPeerUp.getInformation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalAddress
public PeerSessionBuilder 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 PeerSessionBuilder 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
-
setReceivedOpen
public PeerSessionBuilder setReceivedOpen(ReceivedOpen value)
Set the property corresponding toPeerUp.getReceivedOpen()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemotePort
public PeerSessionBuilder 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 PeerSessionBuilder setSentOpen(SentOpen value)
Set the property corresponding toPeerUp.getSentOpen()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStatus
public PeerSessionBuilder setStatus(Status value)
Set the property corresponding toPeerSession.getStatus()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTimestampMicro
public PeerSessionBuilder setTimestampMicro(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
Set the property corresponding toTimestamp.getTimestampMicro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTimestampSec
public PeerSessionBuilder setTimestampSec(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
Set the property corresponding toTimestamp.getTimestampSec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PeerSessionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerSession> 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 PeerSessionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerSession>> 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 PeerSession build()
A newPeerSession
instance.- Returns:
- A new
PeerSession
instance.
-
-