Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.subinterfaces.top.subinterfaces.subinterface.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>
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(State base)
StateBuilder(SubinterfacesConfig arg)
StateBuilder(SubinterfacesState arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description StateBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<State> augmentationValue)
<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()
org.opendaylight.yangtools.yang.common.Uint32
getIfindex()
org.opendaylight.yangtools.yang.common.Uint32
getIndex()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks
getLastChange()
String
getName()
InterfaceCommonState.OperStatus
getOperStatus()
Boolean
isEnabled()
StateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
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.Use {#link setIfindex(Uint32)} instead.StateBuilder
setIfindex(org.opendaylight.yangtools.yang.common.Uint32 value)
StateBuilder
setIndex(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIndex(Uint32)} instead.StateBuilder
setIndex(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
setName(String value)
StateBuilder
setOperStatus(InterfaceCommonState.OperStatus value)
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
-
StateBuilder
public StateBuilder(SubinterfacesConfig arg)
-
StateBuilder
public StateBuilder(InterfaceCommonConfig arg)
-
StateBuilder
public StateBuilder(SubinterfacesState 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.SubinterfacesState
- 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.SubinterfacesConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getAdminStatus
public InterfaceCommonState.AdminStatus getAdminStatus()
-
getCounters
public Counters getCounters()
-
getDescription
public String getDescription()
-
getIfindex
public org.opendaylight.yangtools.yang.common.Uint32 getIfindex()
-
getIndex
public org.opendaylight.yangtools.yang.common.Uint32 getIndex()
-
getLastChange
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks getLastChange()
-
getName
public String getName()
-
getOperStatus
public InterfaceCommonState.OperStatus getOperStatus()
-
isEnabled
public Boolean isEnabled()
-
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)
-
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.Use {#link setIfindex(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIndex
public StateBuilder setIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setIndex
@Deprecated(forRemoval=true) public StateBuilder setIndex(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIndex(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)
-
setName
public StateBuilder setName(String value)
-
setOperStatus
public StateBuilder setOperStatus(InterfaceCommonState.OperStatus value)
-
setEnabled
public StateBuilder setEnabled(Boolean value)
-
addAugmentation
public StateBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<State> augmentationValue)
-
removeAugmentation
public StateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
-
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>
-
-