Class MatchBgpNeighborSetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.match.bgp.neighbor.grouping.MatchBgpNeighborSetBuilder
-
@Generated("mdsal-binding-generator") public class MatchBgpNeighborSetBuilder extends Object
Class that buildsMatchBgpNeighborSet
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:
MatchBgpNeighborSet createMatchBgpNeighborSet(int fooXyzzy, int barBaz) { return new MatchBgpNeighborSetBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MatchBgpNeighborSet, 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:
MatchBgpNeighborSet
- 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
-
-
Constructor Summary
Constructors Constructor Description MatchBgpNeighborSetBuilder()
Construct an empty builder.MatchBgpNeighborSetBuilder(MatchBgpNeighborSet base)
Construct a builder initialized with state from specifiedMatchBgpNeighborSet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MatchBgpNeighborSetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchBgpNeighborSet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchBgpNeighborSet>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MatchBgpNeighborSet
build()
A newMatchBgpNeighborSet
instance.FromNeighbor
getFromNeighbor()
Return current value associated with the property corresponding toMatchBgpNeighborSet.getFromNeighbor()
.ToNeighbor
getToNeighbor()
Return current value associated with the property corresponding toMatchBgpNeighborSet.getToNeighbor()
.MatchBgpNeighborSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchBgpNeighborSet>> augmentationType)
Remove an augmentation from this builder's product.MatchBgpNeighborSetBuilder
setFromNeighbor(FromNeighbor value)
Set the property corresponding toMatchBgpNeighborSet.getFromNeighbor()
to the specified value.MatchBgpNeighborSetBuilder
setToNeighbor(ToNeighbor value)
Set the property corresponding toMatchBgpNeighborSet.getToNeighbor()
to the specified value.
-
-
-
Constructor Detail
-
MatchBgpNeighborSetBuilder
public MatchBgpNeighborSetBuilder()
Construct an empty builder.
-
MatchBgpNeighborSetBuilder
public MatchBgpNeighborSetBuilder(MatchBgpNeighborSet base)
Construct a builder initialized with state from specifiedMatchBgpNeighborSet
.- Parameters:
base
- MatchBgpNeighborSet from which the builder should be initialized
-
-
Method Detail
-
getFromNeighbor
public FromNeighbor getFromNeighbor()
Return current value associated with the property corresponding toMatchBgpNeighborSet.getFromNeighbor()
.- Returns:
- current value
-
getToNeighbor
public ToNeighbor getToNeighbor()
Return current value associated with the property corresponding toMatchBgpNeighborSet.getToNeighbor()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchBgpNeighborSet>> 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
-
setFromNeighbor
public MatchBgpNeighborSetBuilder setFromNeighbor(FromNeighbor value)
Set the property corresponding toMatchBgpNeighborSet.getFromNeighbor()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setToNeighbor
public MatchBgpNeighborSetBuilder setToNeighbor(ToNeighbor value)
Set the property corresponding toMatchBgpNeighborSet.getToNeighbor()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MatchBgpNeighborSetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchBgpNeighborSet> 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 MatchBgpNeighborSetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchBgpNeighborSet>> 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 @NonNull MatchBgpNeighborSet build()
A newMatchBgpNeighborSet
instance.- Returns:
- A new
MatchBgpNeighborSet
instance.
-
-