Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.header
Class PeerHeaderBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.header.PeerHeaderBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PeerHeader>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PeerHeader,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PeerHeaderBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PeerHeader>
Class that buildsPeerHeader
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:
PeerHeader createPeerHeader(int fooXyzzy, int barBaz) { return new PeerHeaderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerHeader, 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:
PeerHeader
,Builder
-
-
Constructor Summary
Constructors Constructor Description PeerHeaderBuilder()
PeerHeaderBuilder(Peer arg)
PeerHeaderBuilder(PeerHeader base)
PeerHeaderBuilder(Timestamp arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PeerHeaderBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerHeader> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerHeader>>
E$$augmentation(Class<E$$> augmentationType)
PeerHeader
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getAddress()
AdjRibInType
getAdjRibInType()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getAs()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getBgpId()
Boolean
getIpv4()
Peer.PeerDistinguisher
getPeerDistinguisher()
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()
PeerType
getType()
PeerHeaderBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerHeader>> augmentationType)
Remove an augmentation from this builder's product.PeerHeaderBuilder
setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
PeerHeaderBuilder
setAdjRibInType(AdjRibInType value)
PeerHeaderBuilder
setAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
PeerHeaderBuilder
setBgpId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
PeerHeaderBuilder
setIpv4(Boolean value)
PeerHeaderBuilder
setPeerDistinguisher(Peer.PeerDistinguisher value)
PeerHeaderBuilder
setTimestampMicro(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
PeerHeaderBuilder
setTimestampSec(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
PeerHeaderBuilder
setType(PeerType value)
-
-
-
Constructor Detail
-
PeerHeaderBuilder
public PeerHeaderBuilder()
-
PeerHeaderBuilder
public PeerHeaderBuilder(Peer arg)
-
PeerHeaderBuilder
public PeerHeaderBuilder(Timestamp arg)
-
PeerHeaderBuilder
public PeerHeaderBuilder(PeerHeader 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:- Peer
- 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
-
getAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getAddress()
-
getAdjRibInType
public AdjRibInType getAdjRibInType()
-
getAs
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAs()
-
getBgpId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpId()
-
getIpv4
public Boolean getIpv4()
-
getPeerDistinguisher
public Peer.PeerDistinguisher getPeerDistinguisher()
-
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()
-
getType
public PeerType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerHeader>> E$$ augmentation(Class<E$$> augmentationType)
-
setAddress
public PeerHeaderBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setAdjRibInType
public PeerHeaderBuilder setAdjRibInType(AdjRibInType value)
-
setAs
public PeerHeaderBuilder setAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
setBgpId
public PeerHeaderBuilder setBgpId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setIpv4
public PeerHeaderBuilder setIpv4(Boolean value)
-
setPeerDistinguisher
public PeerHeaderBuilder setPeerDistinguisher(Peer.PeerDistinguisher value)
-
setTimestampMicro
public PeerHeaderBuilder setTimestampMicro(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
-
setTimestampSec
public PeerHeaderBuilder setTimestampSec(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
-
setType
public PeerHeaderBuilder setType(PeerType value)
-
addAugmentation
public PeerHeaderBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerHeader> 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 PeerHeaderBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerHeader>> 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 PeerHeader build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PeerHeader>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PeerHeader,IllegalArgumentException>
-
-