Class State1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State1Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<State1>
,org.opendaylight.yangtools.concepts.CheckedBuilder<State1,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class State1Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<State1>
Class that buildsState1Builder
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:
State1Builder createTarget(int fooXyzzy, int barBaz) { return new State1BuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of State1Builder, 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:
State1Builder
,Builder
-
-
Constructor Summary
Constructors Constructor Description State1Builder()
State1Builder(BgpContextPfxPathCountersCommon arg)
State1Builder(BgpGlobalAfiSafiState arg)
State1Builder(State1 base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description State1
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getTotalPaths()
org.opendaylight.yangtools.yang.common.Uint32
getTotalPrefixes()
State1Builder
setTotalPaths(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTotalPaths(Uint32)
instead.State1Builder
setTotalPaths(org.opendaylight.yangtools.yang.common.Uint32 value)
State1Builder
setTotalPrefixes(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTotalPrefixes(Uint32)
instead.State1Builder
setTotalPrefixes(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
State1Builder
public State1Builder()
-
State1Builder
public State1Builder(BgpGlobalAfiSafiState arg)
-
State1Builder
public State1Builder(BgpContextPfxPathCountersCommon arg)
-
State1Builder
public State1Builder(State1 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.operational.rev151009.BgpGlobalAfiSafiState
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.operational.rev151009.BgpContextPfxPathCountersCommon
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getTotalPaths
public org.opendaylight.yangtools.yang.common.Uint32 getTotalPaths()
-
getTotalPrefixes
public org.opendaylight.yangtools.yang.common.Uint32 getTotalPrefixes()
-
setTotalPaths
public State1Builder setTotalPaths(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setTotalPaths
@Deprecated(forRemoval=true) public State1Builder setTotalPaths(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTotalPaths(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTotalPrefixes
public State1Builder setTotalPrefixes(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setTotalPrefixes
@Deprecated(forRemoval=true) public State1Builder setTotalPrefixes(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTotalPrefixes(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
build
public State1 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<State1>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<State1,IllegalArgumentException>
-
-