Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.connection.points.connection.point.endpoints.endpoint.StateBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<State>
,org.opendaylight.yangtools.concepts.CheckedBuilder<State,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class StateBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<State>
Class that buildsStateBuilder
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:
StateBuilder createTarget(int fooXyzzy, int barBaz) { return new StateBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of StateBuilder, 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 oportunities, 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:
StateBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description StateBuilder()
StateBuilder(InstanceEndpointConfig arg)
StateBuilder(InstanceEndpointLocalRemote arg)
StateBuilder(InstanceEndpointState arg)
StateBuilder(State base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
State
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getActive()
String
getEndpointId()
LocalRemote
getLocalRemote()
org.opendaylight.yangtools.yang.common.Uint16
getPrecedence()
Boolean
isActive()
Deprecated, for removal: This API element is subject to removal in a future version.StateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
Remove an augmentation from this builder's product.StateBuilder
setActive(Boolean value)
StateBuilder
setEndpointId(String value)
StateBuilder
setLocalRemote(LocalRemote value)
StateBuilder
setPrecedence(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPrecedence(Uint16)
instead.StateBuilder
setPrecedence(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
-
StateBuilder
public StateBuilder(InstanceEndpointConfig arg)
-
StateBuilder
public StateBuilder(InstanceEndpointLocalRemote arg)
-
StateBuilder
public StateBuilder(InstanceEndpointState arg)
-
StateBuilder
public StateBuilder(State 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:- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.InstanceEndpointState
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.InstanceEndpointLocalRemote
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.InstanceEndpointConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getActive
public Boolean getActive()
-
isActive
@Deprecated(forRemoval=true) public final Boolean isActive()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getEndpointId
public String getEndpointId()
-
getLocalRemote
public LocalRemote getLocalRemote()
-
getPrecedence
public org.opendaylight.yangtools.yang.common.Uint16 getPrecedence()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> E$$ augmentation(Class<E$$> augmentationType)
-
setActive
public StateBuilder setActive(Boolean value)
-
setEndpointId
public StateBuilder setEndpointId(String value)
-
setLocalRemote
public StateBuilder setLocalRemote(LocalRemote value)
-
setPrecedence
public StateBuilder setPrecedence(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPrecedence
@Deprecated(forRemoval=true) public StateBuilder setPrecedence(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPrecedence(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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
-
build
public State build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<State>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<State,IllegalArgumentException>
-
-