Class ToNeighborBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.match.bgp.neighbor.grouping.match.bgp.neighbor.set.ToNeighborBuilder
-
@Generated("mdsal-binding-generator") public class ToNeighborBuilder extends Object
Class that buildsToNeighbor
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:
ToNeighbor createToNeighbor(int fooXyzzy, int barBaz) { return new ToNeighborBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ToNeighbor, 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:
ToNeighbor
- 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 ToNeighborBuilder()
Construct an empty builder.ToNeighborBuilder(MatchSetOptionsRestrictedGroup arg)
Construct a new builder initialized from specifiedMatchSetOptionsRestrictedGroup
.ToNeighborBuilder(BgpNeighbor arg)
Construct a new builder initialized from specifiedBgpNeighbor
.ToNeighborBuilder(ToNeighbor base)
Construct a builder initialized with state from specifiedToNeighbor
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ToNeighborBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ToNeighbor> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ToNeighbor>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ToNeighbor
build()
A newToNeighbor
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MatchSetOptionsRestrictedType
getMatchSetOptions()
Return current value associated with the property corresponding toMatchSetOptionsRestrictedGroup.getMatchSetOptions()
.String
getNeighborSet()
Return current value associated with the property corresponding toBgpNeighbor.getNeighborSet()
.ToNeighborBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ToNeighbor>> augmentationType)
Remove an augmentation from this builder's product.ToNeighborBuilder
setMatchSetOptions(MatchSetOptionsRestrictedType value)
Set the property corresponding toMatchSetOptionsRestrictedGroup.getMatchSetOptions()
to the specified value.ToNeighborBuilder
setNeighborSet(String value)
Set the property corresponding toBgpNeighbor.getNeighborSet()
to the specified value.
-
-
-
Constructor Detail
-
ToNeighborBuilder
public ToNeighborBuilder()
Construct an empty builder.
-
ToNeighborBuilder
public ToNeighborBuilder(BgpNeighbor arg)
Construct a new builder initialized from specifiedBgpNeighbor
.- Parameters:
arg
- BgpNeighbor from which the builder should be initialized
-
ToNeighborBuilder
public ToNeighborBuilder(MatchSetOptionsRestrictedGroup arg)
Construct a new builder initialized from specifiedMatchSetOptionsRestrictedGroup
.- Parameters:
arg
- MatchSetOptionsRestrictedGroup from which the builder should be initialized
-
ToNeighborBuilder
public ToNeighborBuilder(ToNeighbor base)
Construct a builder initialized with state from specifiedToNeighbor
.- Parameters:
base
- ToNeighbor from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMatchSetOptions
public MatchSetOptionsRestrictedType getMatchSetOptions()
Return current value associated with the property corresponding toMatchSetOptionsRestrictedGroup.getMatchSetOptions()
.- Returns:
- current value
-
getNeighborSet
public String getNeighborSet()
Return current value associated with the property corresponding toBgpNeighbor.getNeighborSet()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ToNeighbor>> 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
-
setMatchSetOptions
public ToNeighborBuilder setMatchSetOptions(MatchSetOptionsRestrictedType value)
Set the property corresponding toMatchSetOptionsRestrictedGroup.getMatchSetOptions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNeighborSet
public ToNeighborBuilder setNeighborSet(String value)
Set the property corresponding toBgpNeighbor.getNeighborSet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ToNeighborBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ToNeighbor> 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 ToNeighborBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ToNeighbor>> 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 ToNeighbor build()
A newToNeighbor
instance.- Returns:
- A new
ToNeighbor
instance.
-
-