Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329
Class NeighborAddPathsConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborAddPathsConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NeighborAddPathsConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NeighborAddPathsConfig,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NeighborAddPathsConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NeighborAddPathsConfig>
Class that buildsNeighborAddPathsConfigBuilder
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:
NeighborAddPathsConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new NeighborAddPathsConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NeighborAddPathsConfigBuilder, 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:
NeighborAddPathsConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NeighborAddPathsConfigBuilder()
NeighborAddPathsConfigBuilder(BgpNeighborAddPathsConfig arg)
NeighborAddPathsConfigBuilder(NeighborAddPathsConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NeighborAddPathsConfig
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getSendMax()
Boolean
isReceive()
NeighborAddPathsConfigBuilder
setReceive(Boolean value)
NeighborAddPathsConfigBuilder
setSendMax(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSendMax(Uint8)} instead.NeighborAddPathsConfigBuilder
setSendMax(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
NeighborAddPathsConfigBuilder
public NeighborAddPathsConfigBuilder()
-
NeighborAddPathsConfigBuilder
public NeighborAddPathsConfigBuilder(BgpNeighborAddPathsConfig arg)
-
NeighborAddPathsConfigBuilder
public NeighborAddPathsConfigBuilder(NeighborAddPathsConfig base)
-
-
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:- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.BgpNeighborAddPathsConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getSendMax
public org.opendaylight.yangtools.yang.common.Uint8 getSendMax()
-
isReceive
public Boolean isReceive()
-
setSendMax
public NeighborAddPathsConfigBuilder setSendMax(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setSendMax
@Deprecated(forRemoval=true) public NeighborAddPathsConfigBuilder setSendMax(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSendMax(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setReceive
public NeighborAddPathsConfigBuilder setReceive(Boolean value)
-
build
public NeighborAddPathsConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NeighborAddPathsConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NeighborAddPathsConfig,IllegalArgumentException>
-
-