Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.subinterfaces.top.subinterfaces.subinterface.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(InterfaceCommonConfig arg)
Construct a new builder initialized from specifiedInterfaceCommonConfig
.StateBuilder(InterfaceCommonState arg)
Construct a new builder initialized from specifiedInterfaceCommonState
.StateBuilder(InterfaceCountersState arg)
Construct a new builder initialized from specifiedInterfaceCountersState
.StateBuilder(State base)
Construct a builder initialized with state from specifiedState
.StateBuilder(SubinterfacesConfig arg)
Construct a new builder initialized from specifiedSubinterfacesConfig
.StateBuilder(SubinterfacesState arg)
Construct a new builder initialized from specifiedSubinterfacesState
.
-
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.InterfaceCommonState.AdminStatus
getAdminStatus()
Return current value associated with the property corresponding toInterfaceCommonState.getAdminStatus()
.Counters
getCounters()
Return current value associated with the property corresponding toInterfaceCountersState.getCounters()
.String
getDescription()
Return current value associated with the property corresponding toInterfaceCommonConfig.getDescription()
.Boolean
getEnabled()
Return current value associated with the property corresponding toInterfaceCommonConfig.getEnabled()
.org.opendaylight.yangtools.yang.common.Uint32
getIfindex()
Return current value associated with the property corresponding toInterfaceCommonState.getIfindex()
.org.opendaylight.yangtools.yang.common.Uint32
getIndex()
Return current value associated with the property corresponding toSubinterfacesConfig.getIndex()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks
getLastChange()
Return current value associated with the property corresponding toInterfaceCommonState.getLastChange()
.String
getName()
Return current value associated with the property corresponding toInterfaceCommonConfig.getName()
.InterfaceCommonState.OperStatus
getOperStatus()
Return current value associated with the property corresponding toInterfaceCommonState.getOperStatus()
.StateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
Remove an augmentation from this builder's product.StateBuilder
setAdminStatus(InterfaceCommonState.AdminStatus value)
Set the property corresponding toInterfaceCommonState.getAdminStatus()
to the specified value.StateBuilder
setCounters(Counters value)
Set the property corresponding toInterfaceCountersState.getCounters()
to the specified value.StateBuilder
setDescription(String value)
Set the property corresponding toInterfaceCommonConfig.getDescription()
to the specified value.StateBuilder
setEnabled(Boolean value)
Set the property corresponding toInterfaceCommonConfig.getEnabled()
to the specified value.StateBuilder
setIfindex(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toInterfaceCommonState.getIfindex()
to the specified value.StateBuilder
setIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSubinterfacesConfig.getIndex()
to the specified value.StateBuilder
setLastChange(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks value)
Set the property corresponding toInterfaceCommonState.getLastChange()
to the specified value.StateBuilder
setName(String value)
Set the property corresponding toInterfaceCommonConfig.getName()
to the specified value.StateBuilder
setOperStatus(InterfaceCommonState.OperStatus value)
Set the property corresponding toInterfaceCommonState.getOperStatus()
to the specified value.
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
Construct an empty builder.
-
StateBuilder
public StateBuilder(SubinterfacesConfig arg)
Construct a new builder initialized from specifiedSubinterfacesConfig
.- Parameters:
arg
- SubinterfacesConfig from which the builder should be initialized
-
StateBuilder
public StateBuilder(InterfaceCommonConfig arg)
Construct a new builder initialized from specifiedInterfaceCommonConfig
.- Parameters:
arg
- InterfaceCommonConfig from which the builder should be initialized
-
StateBuilder
public StateBuilder(SubinterfacesState arg)
Construct a new builder initialized from specifiedSubinterfacesState
.- Parameters:
arg
- SubinterfacesState from which the builder should be initialized
-
StateBuilder
public StateBuilder(InterfaceCommonState arg)
Construct a new builder initialized from specifiedInterfaceCommonState
.- Parameters:
arg
- InterfaceCommonState from which the builder should be initialized
-
StateBuilder
public StateBuilder(InterfaceCountersState arg)
Construct a new builder initialized from specifiedInterfaceCountersState
.- Parameters:
arg
- InterfaceCountersState 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
-
getAdminStatus
public InterfaceCommonState.AdminStatus getAdminStatus()
Return current value associated with the property corresponding toInterfaceCommonState.getAdminStatus()
.- Returns:
- current value
-
getCounters
public Counters getCounters()
Return current value associated with the property corresponding toInterfaceCountersState.getCounters()
.- Returns:
- current value
-
getDescription
public String getDescription()
Return current value associated with the property corresponding toInterfaceCommonConfig.getDescription()
.- Returns:
- current value
-
getEnabled
public Boolean getEnabled()
Return current value associated with the property corresponding toInterfaceCommonConfig.getEnabled()
.- Returns:
- current value
-
getIfindex
public org.opendaylight.yangtools.yang.common.Uint32 getIfindex()
Return current value associated with the property corresponding toInterfaceCommonState.getIfindex()
.- Returns:
- current value
-
getIndex
public org.opendaylight.yangtools.yang.common.Uint32 getIndex()
Return current value associated with the property corresponding toSubinterfacesConfig.getIndex()
.- Returns:
- current value
-
getLastChange
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks getLastChange()
Return current value associated with the property corresponding toInterfaceCommonState.getLastChange()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toInterfaceCommonConfig.getName()
.- Returns:
- current value
-
getOperStatus
public InterfaceCommonState.OperStatus getOperStatus()
Return current value associated with the property corresponding toInterfaceCommonState.getOperStatus()
.- 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
-
setAdminStatus
public StateBuilder setAdminStatus(InterfaceCommonState.AdminStatus value)
Set the property corresponding toInterfaceCommonState.getAdminStatus()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCounters
public StateBuilder setCounters(Counters value)
Set the property corresponding toInterfaceCountersState.getCounters()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDescription
public StateBuilder setDescription(String value)
Set the property corresponding toInterfaceCommonConfig.getDescription()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEnabled
public StateBuilder setEnabled(Boolean value)
Set the property corresponding toInterfaceCommonConfig.getEnabled()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIfindex
public StateBuilder setIfindex(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toInterfaceCommonState.getIfindex()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIndex
public StateBuilder setIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSubinterfacesConfig.getIndex()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLastChange
public StateBuilder setLastChange(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks value)
Set the property corresponding toInterfaceCommonState.getLastChange()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
public StateBuilder setName(String value)
Set the property corresponding toInterfaceCommonConfig.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOperStatus
public StateBuilder setOperStatus(InterfaceCommonState.OperStatus value)
Set the property corresponding toInterfaceCommonState.getOperStatus()
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
-
-