Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib
Class PeerBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.PeerBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Peer>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Peer,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PeerBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Peer>
Class that buildsPeerBuilder
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:
PeerBuilder createTarget(int fooXyzzy, int barBaz) { return new PeerBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerBuilder, 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 oportunities, 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:
PeerBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PeerBuilder()
PeerBuilder(Peer base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PeerBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Peer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Peer> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.PeerBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Peer> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Peer>>
E$$augmentation(Class<E$$> augmentationType)
Peer
build()
AdjRibIn
getAdjRibIn()
AdjRibOut
getAdjRibOut()
EffectiveRibIn
getEffectiveRibIn()
PeerId
getPeerId()
PeerRole
getPeerRole()
Map<SupportedTablesKey,SupportedTables>
getSupportedTables()
PeerKey
key()
PeerBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Peer>> augmentationType)
Remove an augmentation from this builder's product.PeerBuilder
setAdjRibIn(AdjRibIn value)
PeerBuilder
setAdjRibOut(AdjRibOut value)
PeerBuilder
setEffectiveRibIn(EffectiveRibIn value)
PeerBuilder
setPeerId(PeerId value)
PeerBuilder
setPeerRole(PeerRole value)
PeerBuilder
setSupportedTables(List<SupportedTables> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSupportedTables(Map)
instead.PeerBuilder
setSupportedTables(Map<SupportedTablesKey,SupportedTables> values)
PeerBuilder
withKey(PeerKey key)
-
-
-
Constructor Detail
-
PeerBuilder
public PeerBuilder()
-
PeerBuilder
public PeerBuilder(Peer base)
-
-
Method Detail
-
key
public PeerKey key()
-
getAdjRibIn
public AdjRibIn getAdjRibIn()
-
getAdjRibOut
public AdjRibOut getAdjRibOut()
-
getEffectiveRibIn
public EffectiveRibIn getEffectiveRibIn()
-
getPeerId
public PeerId getPeerId()
-
getPeerRole
public PeerRole getPeerRole()
-
getSupportedTables
public Map<SupportedTablesKey,SupportedTables> getSupportedTables()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Peer>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PeerBuilder withKey(PeerKey key)
-
setAdjRibIn
public PeerBuilder setAdjRibIn(AdjRibIn value)
-
setAdjRibOut
public PeerBuilder setAdjRibOut(AdjRibOut value)
-
setEffectiveRibIn
public PeerBuilder setEffectiveRibIn(EffectiveRibIn value)
-
setPeerId
public PeerBuilder setPeerId(PeerId value)
-
setPeerRole
public PeerBuilder setPeerRole(PeerRole value)
-
setSupportedTables
public PeerBuilder setSupportedTables(Map<SupportedTablesKey,SupportedTables> values)
-
setSupportedTables
@Deprecated(forRemoval=true) public PeerBuilder setSupportedTables(List<SupportedTables> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSupportedTables(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public PeerBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Peer> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public PeerBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Peer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Peer> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public PeerBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Peer>> 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 Peer build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Peer>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Peer,IllegalArgumentException>
-
-