Class StateBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.procmon.rev190315.procmon.processes.top.processes.process.StateBuilder
Class that builds
State 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.StateBuilder(State base) Construct a builder initialized with state from specifiedState.Construct a new builder initialized from specifiedProcmonProcessAttributesState. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation(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 Statebuild()A newStateinstance.static @NonNull Stateempty()Get empty instance of State.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getArgs()Return current value associated with the property corresponding toProcmonProcessAttributesState.getArgs().Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUsageSystem().Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUsageUser().Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUtilization().org.opendaylight.yangtools.yang.common.Uint64Return current value associated with the property corresponding toProcmonProcessAttributesState.getMemoryUsage().Return current value associated with the property corresponding toProcmonProcessAttributesState.getMemoryUtilization().getName()Return current value associated with the property corresponding toProcmonProcessAttributesState.getName().org.opendaylight.yangtools.yang.common.Uint64getPid()Return current value associated with the property corresponding toProcmonProcessAttributesState.getPid().Return current value associated with the property corresponding toProcmonProcessAttributesState.getStartTime().removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toProcmonProcessAttributesState.getArgs()to the specified value.setCpuUsageSystem(Counter64 value) Set the property corresponding toProcmonProcessAttributesState.getCpuUsageSystem()to the specified value.setCpuUsageUser(Counter64 value) Set the property corresponding toProcmonProcessAttributesState.getCpuUsageUser()to the specified value.setCpuUtilization(Percentage value) Set the property corresponding toProcmonProcessAttributesState.getCpuUtilization()to the specified value.setMemoryUsage(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toProcmonProcessAttributesState.getMemoryUsage()to the specified value.setMemoryUtilization(Percentage value) Set the property corresponding toProcmonProcessAttributesState.getMemoryUtilization()to the specified value.Set the property corresponding toProcmonProcessAttributesState.getName()to the specified value.setPid(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toProcmonProcessAttributesState.getPid()to the specified value.setStartTime(Timeticks64 value) Set the property corresponding toProcmonProcessAttributesState.getStartTime()to the specified value.
-
Constructor Details
-
StateBuilder
public StateBuilder()Construct an empty builder. -
StateBuilder
Construct a new builder initialized from specifiedProcmonProcessAttributesState.- Parameters:
arg- ProcmonProcessAttributesState from which the builder should be initialized
-
StateBuilder
Construct a builder initialized with state from specifiedState.- Parameters:
base- State from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of State.- Returns:
- An empty
State
-
getArgs
Return current value associated with the property corresponding toProcmonProcessAttributesState.getArgs().- Returns:
- current value
-
getCpuUsageSystem
Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUsageSystem().- Returns:
- current value
-
getCpuUsageUser
Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUsageUser().- Returns:
- current value
-
getCpuUtilization
Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUtilization().- Returns:
- current value
-
getMemoryUsage
public org.opendaylight.yangtools.yang.common.Uint64 getMemoryUsage()Return current value associated with the property corresponding toProcmonProcessAttributesState.getMemoryUsage().- Returns:
- current value
-
getMemoryUtilization
Return current value associated with the property corresponding toProcmonProcessAttributesState.getMemoryUtilization().- Returns:
- current value
-
getName
Return current value associated with the property corresponding toProcmonProcessAttributesState.getName().- Returns:
- current value
-
getPid
public org.opendaylight.yangtools.yang.common.Uint64 getPid()Return current value associated with the property corresponding toProcmonProcessAttributesState.getPid().- Returns:
- current value
-
getStartTime
Return current value associated with the property corresponding toProcmonProcessAttributesState.getStartTime().- 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
nullif not present - Throws:
NullPointerException- ifaugmentTypeisnull
-
setArgs
Set the property corresponding toProcmonProcessAttributesState.getArgs()to the specified value.- Parameters:
values- desired value- Returns:
- this builder
-
setCpuUsageSystem
Set the property corresponding toProcmonProcessAttributesState.getCpuUsageSystem()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setCpuUsageUser
Set the property corresponding toProcmonProcessAttributesState.getCpuUsageUser()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setCpuUtilization
Set the property corresponding toProcmonProcessAttributesState.getCpuUtilization()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMemoryUsage
Set the property corresponding toProcmonProcessAttributesState.getMemoryUsage()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMemoryUtilization
Set the property corresponding toProcmonProcessAttributesState.getMemoryUtilization()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setName
Set the property corresponding toProcmonProcessAttributesState.getName()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setPid
Set the property corresponding toProcmonProcessAttributesState.getPid()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setStartTime
Set the property corresponding toProcmonProcessAttributesState.getStartTime()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- ifaugmentationis 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
A newStateinstance.- Returns:
- A new
Stateinstance.
-