Class RibBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Rib>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Rib,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RibBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Rib>
Class that buildsRibBuilder
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:
RibBuilder createTarget(int fooXyzzy, int barBaz) { return new RibBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RibBuilder, 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:
RibBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RibBuilder()
RibBuilder(Rib base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RibBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Rib> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rib>>
E$$augmentation(Class<E$$> augmentationType)
Rib
build()
RibId
getId()
LocRib
getLocRib()
Map<PeerKey,Peer>
getPeer()
RibKey
key()
RibBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rib>> augmentationType)
Remove an augmentation from this builder's product.RibBuilder
setId(RibId value)
RibBuilder
setLocRib(LocRib value)
RibBuilder
setPeer(List<Peer> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPeer(Map)
instead.RibBuilder
setPeer(Map<PeerKey,Peer> values)
RibBuilder
withKey(RibKey key)
-
-
-
Constructor Detail
-
RibBuilder
public RibBuilder()
-
RibBuilder
public RibBuilder(Rib base)
-
-
Method Detail
-
key
public RibKey key()
-
getId
public RibId getId()
-
getLocRib
public LocRib getLocRib()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rib>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public RibBuilder withKey(RibKey key)
-
setId
public RibBuilder setId(RibId value)
-
setLocRib
public RibBuilder setLocRib(LocRib value)
-
setPeer
public RibBuilder setPeer(Map<PeerKey,Peer> values)
-
setPeer
@Deprecated(forRemoval=true) public RibBuilder setPeer(List<Peer> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPeer(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 RibBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Rib> 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 RibBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rib>> 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 Rib build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Rib>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Rib,IllegalArgumentException>
-
-