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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PeerSession>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PeerSession,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PeerSessionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PeerSession>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description PeerSessionBuilder()
PeerSessionBuilder(PeerUp arg)
PeerSessionBuilder(Timestamp arg)
PeerSessionBuilder(PeerSession base)
-
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)
PeerSession
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Information
getInformation()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getLocalAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getLocalPort()
ReceivedOpen
getReceivedOpen()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getRemotePort()
SentOpen
getSentOpen()
Status
getStatus()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp
getTimestampMicro()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp
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)
PeerSessionBuilder
setLocalAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
PeerSessionBuilder
setLocalPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
PeerSessionBuilder
setReceivedOpen(ReceivedOpen value)
PeerSessionBuilder
setRemotePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
PeerSessionBuilder
setSentOpen(SentOpen value)
PeerSessionBuilder
setStatus(Status value)
PeerSessionBuilder
setTimestampMicro(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
PeerSessionBuilder
setTimestampSec(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
-
-
-
Constructor Detail
-
PeerSessionBuilder
public PeerSessionBuilder()
-
PeerSessionBuilder
public PeerSessionBuilder(PeerUp arg)
-
PeerSessionBuilder
public PeerSessionBuilder(Timestamp arg)
-
PeerSessionBuilder
public PeerSessionBuilder(PeerSession 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:- PeerUp
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.Timestamp
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getInformation
public Information getInformation()
-
getLocalAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getLocalAddress()
-
getLocalPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLocalPort()
-
getReceivedOpen
public ReceivedOpen getReceivedOpen()
-
getRemotePort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getRemotePort()
-
getSentOpen
public SentOpen getSentOpen()
-
getStatus
public Status getStatus()
-
getTimestampMicro
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampMicro()
-
getTimestampSec
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getTimestampSec()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerSession>> E$$ augmentation(Class<E$$> augmentationType)
-
setInformation
public PeerSessionBuilder setInformation(Information value)
-
setLocalAddress
public PeerSessionBuilder setLocalAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setLocalPort
public PeerSessionBuilder setLocalPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
setReceivedOpen
public PeerSessionBuilder setReceivedOpen(ReceivedOpen value)
-
setRemotePort
public PeerSessionBuilder setRemotePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
setSentOpen
public PeerSessionBuilder setSentOpen(SentOpen value)
-
setStatus
public PeerSessionBuilder setStatus(Status value)
-
setTimestampMicro
public PeerSessionBuilder setTimestampMicro(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
-
setTimestampSec
public PeerSessionBuilder setTimestampSec(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
-
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 PeerSession build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PeerSession>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PeerSession,IllegalArgumentException>
-
-