Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.interfaces.top.interfaces._interface.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(InterfaceCommonConfig arg)
StateBuilder(InterfaceCommonState arg)
StateBuilder(InterfaceCountersState arg)
StateBuilder(InterfacePhysConfig 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.InterfaceCommonState.AdminStatus
getAdminStatus()
Counters
getCounters()
String
getDescription()
Boolean
getEnabled()
org.opendaylight.yangtools.yang.common.Uint32
getIfindex()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks
getLastChange()
org.opendaylight.yangtools.yang.common.Uint16
getMtu()
String
getName()
InterfaceCommonState.OperStatus
getOperStatus()
Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType>
getType()
Boolean
isEnabled()
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
setAdminStatus(InterfaceCommonState.AdminStatus value)
StateBuilder
setCounters(Counters value)
StateBuilder
setDescription(String value)
StateBuilder
setEnabled(Boolean value)
StateBuilder
setIfindex(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIfindex(Uint32)
instead.StateBuilder
setIfindex(org.opendaylight.yangtools.yang.common.Uint32 value)
StateBuilder
setLastChange(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks value)
StateBuilder
setMtu(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMtu(Uint16)
instead.StateBuilder
setMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
StateBuilder
setName(String value)
StateBuilder
setOperStatus(InterfaceCommonState.OperStatus value)
StateBuilder
setType(Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> value)
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
-
StateBuilder
public StateBuilder(InterfacePhysConfig arg)
-
StateBuilder
public StateBuilder(InterfaceCommonConfig arg)
-
StateBuilder
public StateBuilder(InterfaceCommonState arg)
-
StateBuilder
public StateBuilder(InterfaceCountersState 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.interfaces.rev160412.InterfaceCommonConfig
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfaceCountersState
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfaceCommonState
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfacePhysConfig
- 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()
-
getCounters
public Counters getCounters()
-
getDescription
public String getDescription()
-
getEnabled
public Boolean getEnabled()
-
isEnabled
@Deprecated(forRemoval=true) public final Boolean isEnabled()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getIfindex
public org.opendaylight.yangtools.yang.common.Uint32 getIfindex()
-
getLastChange
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks getLastChange()
-
getMtu
public org.opendaylight.yangtools.yang.common.Uint16 getMtu()
-
getName
public String getName()
-
getOperStatus
public InterfaceCommonState.OperStatus getOperStatus()
-
getType
public Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> E$$ augmentation(Class<E$$> augmentationType)
-
setAdminStatus
public StateBuilder setAdminStatus(InterfaceCommonState.AdminStatus value)
-
setCounters
public StateBuilder setCounters(Counters value)
-
setDescription
public StateBuilder setDescription(String value)
-
setEnabled
public StateBuilder setEnabled(Boolean value)
-
setIfindex
public StateBuilder setIfindex(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setIfindex
@Deprecated(forRemoval=true) public StateBuilder setIfindex(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIfindex(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setLastChange
public StateBuilder setLastChange(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks value)
-
setMtu
public StateBuilder setMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMtu
@Deprecated(forRemoval=true) public StateBuilder setMtu(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMtu(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setName
public StateBuilder setName(String value)
-
setOperStatus
public StateBuilder setOperStatus(InterfaceCommonState.OperStatus value)
-
setType
public StateBuilder setType(Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> 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>
-
-