Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.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 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
,Builder
-
-
Constructor Summary
Constructors Constructor Description StateBuilder()
StateBuilder(State base)
StateBuilder(NetworkInstanceConfig arg)
StateBuilder(NetworkInstanceL3vrfConfig arg)
StateBuilder(NetworkInstanceState arg)
-
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)
State
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getDescription()
Boolean
getEnabled()
String
getName()
RouteDistinguisher
getRouteDistinguisher()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad
getRouterId()
Class<? extends NetworkInstanceType>
getType()
StateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
Remove an augmentation from this builder's product.StateBuilder
setDescription(String value)
StateBuilder
setEnabled(Boolean value)
StateBuilder
setName(String value)
StateBuilder
setRouteDistinguisher(RouteDistinguisher value)
StateBuilder
setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad value)
StateBuilder
setType(Class<? extends NetworkInstanceType> value)
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
-
StateBuilder
public StateBuilder(NetworkInstanceConfig arg)
-
StateBuilder
public StateBuilder(NetworkInstanceL3vrfConfig arg)
-
StateBuilder
public StateBuilder(NetworkInstanceState 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:- NetworkInstanceState
- NetworkInstanceL3vrfConfig
- NetworkInstanceConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getDescription
public String getDescription()
-
getEnabled
public Boolean getEnabled()
-
getName
public String getName()
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
-
getRouterId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad getRouterId()
-
getType
public Class<? extends NetworkInstanceType> getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> E$$ augmentation(Class<E$$> augmentationType)
-
setDescription
public StateBuilder setDescription(String value)
-
setEnabled
public StateBuilder setEnabled(Boolean value)
-
setName
public StateBuilder setName(String value)
-
setRouteDistinguisher
public StateBuilder setRouteDistinguisher(RouteDistinguisher value)
-
setRouterId
public StateBuilder setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad value)
-
setType
public StateBuilder setType(Class<? extends NetworkInstanceType> value)
-
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>
-
-