Class BgpBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.BgpBuilder
Class that builds
Bgp
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:
Bgp createBgp(int fooXyzzy, int barBaz) {
return new BgpBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Bgp, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.BgpBuilder
(Bgp base) Construct a builder initialized with state from specifiedBgp
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Bgp> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<Bgp>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Bgp
build()
A newBgp
instance.Return current value associated with the property corresponding toBgp.getGlobal()
.Return current value associated with the property corresponding toBgp.getNeighbors()
.Return current value associated with the property corresponding toBgp.getPeerGroups()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Bgp>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toBgp.getGlobal()
to the specified value.setNeighbors
(Neighbors value) Set the property corresponding toBgp.getNeighbors()
to the specified value.setPeerGroups
(PeerGroups value) Set the property corresponding toBgp.getPeerGroups()
to the specified value.
-
Constructor Details
-
BgpBuilder
public BgpBuilder()Construct an empty builder. -
BgpBuilder
Construct a builder initialized with state from specifiedBgp
.- Parameters:
base
- Bgp from which the builder should be initialized
-
-
Method Details
-
getGlobal
Return current value associated with the property corresponding toBgp.getGlobal()
.- Returns:
- current value
-
getNeighbors
Return current value associated with the property corresponding toBgp.getNeighbors()
.- Returns:
- current value
-
getPeerGroups
Return current value associated with the property corresponding toBgp.getPeerGroups()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<Bgp>> 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
-
setGlobal
Set the property corresponding toBgp.getGlobal()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNeighbors
Set the property corresponding toBgp.getNeighbors()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerGroups
Set the property corresponding toBgp.getPeerGroups()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BgpBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<Bgp> 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 BgpBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Bgp>> 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
A newBgp
instance.- Returns:
- A new
Bgp
instance.
-