Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.procmon.rev190315.procmon.processes.top.processes.process.StateBuilder
-
@Generated("mdsal-binding-generator") public class StateBuilder extends Object
Class that buildsStateinstances. 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(State base)Construct a builder initialized with state from specifiedState.StateBuilder(ProcmonProcessAttributesState arg)Construct a new builder initialized from specifiedProcmonProcessAttributesState.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StateBuilderaddAugmentation(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.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)Set fields from given grouping argument.Set<String>getArgs()Return current value associated with the property corresponding toProcmonProcessAttributesState.getArgs().Counter64getCpuUsageSystem()Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUsageSystem().Counter64getCpuUsageUser()Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUsageUser().PercentagegetCpuUtilization()Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUtilization().org.opendaylight.yangtools.yang.common.Uint64getMemoryUsage()Return current value associated with the property corresponding toProcmonProcessAttributesState.getMemoryUsage().PercentagegetMemoryUtilization()Return current value associated with the property corresponding toProcmonProcessAttributesState.getMemoryUtilization().StringgetName()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().Timeticks64getStartTime()Return current value associated with the property corresponding toProcmonProcessAttributesState.getStartTime().StateBuilderremoveAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)Remove an augmentation from this builder's product.StateBuildersetArgs(Set<String> values)Set the property corresponding toProcmonProcessAttributesState.getArgs()to the specified value.StateBuildersetCpuUsageSystem(Counter64 value)Set the property corresponding toProcmonProcessAttributesState.getCpuUsageSystem()to the specified value.StateBuildersetCpuUsageUser(Counter64 value)Set the property corresponding toProcmonProcessAttributesState.getCpuUsageUser()to the specified value.StateBuildersetCpuUtilization(Percentage value)Set the property corresponding toProcmonProcessAttributesState.getCpuUtilization()to the specified value.StateBuildersetMemoryUsage(org.opendaylight.yangtools.yang.common.Uint64 value)Set the property corresponding toProcmonProcessAttributesState.getMemoryUsage()to the specified value.StateBuildersetMemoryUtilization(Percentage value)Set the property corresponding toProcmonProcessAttributesState.getMemoryUtilization()to the specified value.StateBuildersetName(String value)Set the property corresponding toProcmonProcessAttributesState.getName()to the specified value.StateBuildersetPid(org.opendaylight.yangtools.yang.common.Uint64 value)Set the property corresponding toProcmonProcessAttributesState.getPid()to the specified value.StateBuildersetStartTime(Timeticks64 value)Set the property corresponding toProcmonProcessAttributesState.getStartTime()to the specified value.
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
Construct an empty builder.
-
StateBuilder
public StateBuilder(ProcmonProcessAttributesState arg)
Construct a new builder initialized from specifiedProcmonProcessAttributesState.- Parameters:
arg- ProcmonProcessAttributesState 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
-
getArgs
public Set<String> getArgs()
Return current value associated with the property corresponding toProcmonProcessAttributesState.getArgs().- Returns:
- current value
-
getCpuUsageSystem
public Counter64 getCpuUsageSystem()
Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUsageSystem().- Returns:
- current value
-
getCpuUsageUser
public Counter64 getCpuUsageUser()
Return current value associated with the property corresponding toProcmonProcessAttributesState.getCpuUsageUser().- Returns:
- current value
-
getCpuUtilization
public Percentage 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
public Percentage getMemoryUtilization()
Return current value associated with the property corresponding toProcmonProcessAttributesState.getMemoryUtilization().- Returns:
- current value
-
getName
public String 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
public Timeticks64 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
public StateBuilder setArgs(Set<String> values)
Set the property corresponding toProcmonProcessAttributesState.getArgs()to the specified value.- Parameters:
values- desired value- Returns:
- this builder
-
setCpuUsageSystem
public StateBuilder setCpuUsageSystem(Counter64 value)
Set the property corresponding toProcmonProcessAttributesState.getCpuUsageSystem()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setCpuUsageUser
public StateBuilder setCpuUsageUser(Counter64 value)
Set the property corresponding toProcmonProcessAttributesState.getCpuUsageUser()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setCpuUtilization
public StateBuilder setCpuUtilization(Percentage value)
Set the property corresponding toProcmonProcessAttributesState.getCpuUtilization()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMemoryUsage
public StateBuilder setMemoryUsage(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toProcmonProcessAttributesState.getMemoryUsage()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMemoryUtilization
public StateBuilder setMemoryUtilization(Percentage value)
Set the property corresponding toProcmonProcessAttributesState.getMemoryUtilization()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setName
public StateBuilder setName(String value)
Set the property corresponding toProcmonProcessAttributesState.getName()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setPid
public StateBuilder setPid(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toProcmonProcessAttributesState.getPid()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setStartTime
public StateBuilder setStartTime(Timeticks64 value)
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
-
-