Class State3Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State3Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<State3>
,org.opendaylight.yangtools.concepts.CheckedBuilder<State3,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class State3Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<State3>
Class that buildsState3
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:
State3 createState3(int fooXyzzy, int barBaz) { return new State3Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of State3, 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:
State3
,Builder
-
-
Constructor Summary
Constructors Constructor Description State3Builder()
State3Builder(BgpNeighborAfiSafiState arg)
State3Builder(BgpNeighborPrefixCountersState arg)
State3Builder(State3 base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description State3
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getActive()
Prefixes
getPrefixes()
State3Builder
setActive(Boolean value)
State3Builder
setPrefixes(Prefixes value)
-
-
-
Constructor Detail
-
State3Builder
public State3Builder()
-
State3Builder
public State3Builder(BgpNeighborAfiSafiState arg)
-
State3Builder
public State3Builder(BgpNeighborPrefixCountersState arg)
-
State3Builder
public State3Builder(State3 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:- BgpNeighborPrefixCountersState
- BgpNeighborAfiSafiState
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getActive
public Boolean getActive()
-
getPrefixes
public Prefixes getPrefixes()
-
setActive
public State3Builder setActive(Boolean value)
-
setPrefixes
public State3Builder setPrefixes(Prefixes value)
-
build
public State3 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<State3>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<State3,IllegalArgumentException>
-
-