Class State13Builder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State13Builder
Class that builds
State13
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:
State13 createState13(int fooXyzzy, int barBaz) {
return new State13Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of State13, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedBgpContextPfxPathCountersCommon
.Construct a new builder initialized from specifiedBgpPeerGroupState
.State13Builder
(State13 base) Construct a builder initialized with state from specifiedState13
. -
Method Summary
Modifier and TypeMethodDescription@NonNull State13
build()
A newState13
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toBgpContextPfxPathCountersCommon.getTotalPaths()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toBgpContextPfxPathCountersCommon.getTotalPrefixes()
.setTotalPaths
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toBgpContextPfxPathCountersCommon.getTotalPaths()
to the specified value.setTotalPrefixes
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toBgpContextPfxPathCountersCommon.getTotalPrefixes()
to the specified value.
-
Constructor Details
-
State13Builder
public State13Builder()Construct an empty builder. -
State13Builder
Construct a new builder initialized from specifiedBgpPeerGroupState
.- Parameters:
arg
- BgpPeerGroupState from which the builder should be initialized
-
State13Builder
Construct a new builder initialized from specifiedBgpContextPfxPathCountersCommon
.- Parameters:
arg
- BgpContextPfxPathCountersCommon from which the builder should be initialized
-
State13Builder
Construct a builder initialized with state from specifiedState13
.- Parameters:
base
- State13 from which the builder should be initialized
-
-
Method Details
-
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
Set the property corresponding toBgpContextPfxPathCountersCommon.getTotalPaths()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTotalPrefixes
Set the property corresponding toBgpContextPfxPathCountersCommon.getTotalPrefixes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newState13
instance.- Returns:
- A new
State13
instance.
-