Class State1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State1Builder
-
@Generated("mdsal-binding-generator") public class State1Builder extends Object
Class that buildsState1
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:
State1 createState1(int fooXyzzy, int barBaz) { return new State1Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of State1, 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:
State1
- 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 State1Builder()
Construct an empty builder.State1Builder(BgpContextPfxPathCountersCommon arg)
Construct a new builder initialized from specifiedBgpContextPfxPathCountersCommon
.State1Builder(BgpGlobalAfiSafiState arg)
Construct a new builder initialized from specifiedBgpGlobalAfiSafiState
.State1Builder(State1 base)
Construct a builder initialized with state from specifiedState1
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull State1
build()
A newState1
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getTotalPaths()
Return current value associated with the property corresponding toBgpContextPfxPathCountersCommon.getTotalPaths()
.org.opendaylight.yangtools.yang.common.Uint32
getTotalPrefixes()
Return current value associated with the property corresponding toBgpContextPfxPathCountersCommon.getTotalPrefixes()
.State1Builder
setTotalPaths(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBgpContextPfxPathCountersCommon.getTotalPaths()
to the specified value.State1Builder
setTotalPrefixes(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBgpContextPfxPathCountersCommon.getTotalPrefixes()
to the specified value.
-
-
-
Constructor Detail
-
State1Builder
public State1Builder()
Construct an empty builder.
-
State1Builder
public State1Builder(BgpGlobalAfiSafiState arg)
Construct a new builder initialized from specifiedBgpGlobalAfiSafiState
.- Parameters:
arg
- BgpGlobalAfiSafiState from which the builder should be initialized
-
State1Builder
public State1Builder(BgpContextPfxPathCountersCommon arg)
Construct a new builder initialized from specifiedBgpContextPfxPathCountersCommon
.- Parameters:
arg
- BgpContextPfxPathCountersCommon 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
-
getTotalPaths
public org.opendaylight.yangtools.yang.common.Uint32 getTotalPaths()
Return current value associated with the property corresponding toBgpContextPfxPathCountersCommon.getTotalPaths()
.- Returns:
- current value
-
getTotalPrefixes
public org.opendaylight.yangtools.yang.common.Uint32 getTotalPrefixes()
Return current value associated with the property corresponding toBgpContextPfxPathCountersCommon.getTotalPrefixes()
.- Returns:
- current value
-
setTotalPaths
public State1Builder setTotalPaths(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBgpContextPfxPathCountersCommon.getTotalPaths()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTotalPrefixes
public State1Builder setTotalPrefixes(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toBgpContextPfxPathCountersCommon.getTotalPrefixes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
-