Class StateBuilder
java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<State,StateBuilder>
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412._interface.ref.state.container.StateBuilder
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator")
public class StateBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<State,StateBuilder>
Class that builds
State 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:
State createState(int fooXyzzy, int barBaz) {
return new StateBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of State, 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
ConstructorsConstructorDescriptionConstruct an empty builder.StateBuilder(State base) Construct a builder initialized with state from specifiedState.Construct a new builder initialized from specifiedInterfaceRefCommon. -
Method Summary
Modifier and TypeMethodDescription@NonNull Statebuild()Returns A newStateinstance.static @NonNull Stateempty()Returns an emptyState.voidfieldsFrom(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseorg.opendaylight.yangtools.yang.common.Uint32Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releasesetInterface(String value) Set the property corresponding toInterfaceRefCommon.getInterface()to the specified value.setSubinterface(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toInterfaceRefCommon.getSubinterface()to the specified value.Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder
addAugmentation, augmentation, augmentations, removeAugmentation
-
Constructor Details
-
StateBuilder
public StateBuilder()Construct an empty builder. -
StateBuilder
Construct a new builder initialized from specifiedInterfaceRefCommon.- Parameters:
arg- InterfaceRefCommon from which the builder should be initialized
-
StateBuilder
Construct a builder initialized with state from specifiedState.- Parameters:
base- State from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
empty
Returns an emptyState.- Returns:
- an empty
State
-
getInterface
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toInterfaceRefCommon.getInterface().- Returns:
- current value
-
getSubinterface
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toInterfaceRefCommon.getSubinterface().- Returns:
- current value
-
setInterface
Set the property corresponding toInterfaceRefCommon.getInterface()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setSubinterface
Set the property corresponding toInterfaceRefCommon.getSubinterface()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
build
Returns A newStateinstance.- Returns:
- A new
Stateinstance
-