Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.protocol.StateBuilder
-
@Generated("mdsal-binding-generator") public class StateBuilder extends Object
Class that buildsState
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:
State
- 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 StateBuilder()
Construct an empty builder.StateBuilder(State base)
Construct a builder initialized with state from specifiedState
.StateBuilder(ProtocolsConfig arg)
Construct a new builder initialized from specifiedProtocolsConfig
.StateBuilder(ProtocolsState arg)
Construct a new builder initialized from specifiedProtocolsState
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StateBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<State> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull State
build()
A newState
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getEnabled()
Return current value associated with the property corresponding toProtocolsConfig.getEnabled()
.Class<? extends InstallProtocolType>
getIdentifier()
Return current value associated with the property corresponding toProtocolsConfig.getIdentifier()
.String
getName()
Return current value associated with the property corresponding toProtocolsConfig.getName()
.String
getTargetTable()
Return current value associated with the property corresponding toProtocolsConfig.getTargetTable()
.StateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
Remove an augmentation from this builder's product.StateBuilder
setEnabled(Boolean value)
Set the property corresponding toProtocolsConfig.getEnabled()
to the specified value.StateBuilder
setIdentifier(Class<? extends InstallProtocolType> value)
Set the property corresponding toProtocolsConfig.getIdentifier()
to the specified value.StateBuilder
setName(String value)
Set the property corresponding toProtocolsConfig.getName()
to the specified value.StateBuilder
setTargetTable(String value)
Set the property corresponding toProtocolsConfig.getTargetTable()
to the specified value.
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
Construct an empty builder.
-
StateBuilder
public StateBuilder(ProtocolsConfig arg)
Construct a new builder initialized from specifiedProtocolsConfig
.- Parameters:
arg
- ProtocolsConfig from which the builder should be initialized
-
StateBuilder
public StateBuilder(ProtocolsState arg)
Construct a new builder initialized from specifiedProtocolsState
.- Parameters:
arg
- ProtocolsState 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
-
getEnabled
public Boolean getEnabled()
Return current value associated with the property corresponding toProtocolsConfig.getEnabled()
.- Returns:
- current value
-
getIdentifier
public Class<? extends InstallProtocolType> getIdentifier()
Return current value associated with the property corresponding toProtocolsConfig.getIdentifier()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toProtocolsConfig.getName()
.- Returns:
- current value
-
getTargetTable
public String getTargetTable()
Return current value associated with the property corresponding toProtocolsConfig.getTargetTable()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setEnabled
public StateBuilder setEnabled(Boolean value)
Set the property corresponding toProtocolsConfig.getEnabled()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdentifier
public StateBuilder setIdentifier(Class<? extends InstallProtocolType> value)
Set the property corresponding toProtocolsConfig.getIdentifier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
public StateBuilder setName(String value)
Set the property corresponding toProtocolsConfig.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTargetTable
public StateBuilder setTargetTable(String value)
Set the property corresponding toProtocolsConfig.getTargetTable()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public StateBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<State> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public StateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
-