Class TotalBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.cpu.state.TotalBuilder
-
@Generated("mdsal-binding-generator") public class TotalBuilder extends Object
Class that buildsTotalinstances. 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:
Total createTotal(int fooXyzzy, int barBaz) { return new TotalBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }This pattern is supported by the immutable nature of Total, 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:
Total
- 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 TotalBuilder()Construct an empty builder.TotalBuilder(AvgMinMaxInstantStatsPct arg)Construct a new builder initialized from specifiedAvgMinMaxInstantStatsPct.TotalBuilder(MinMaxTime arg)Construct a new builder initialized from specifiedMinMaxTime.TotalBuilder(StatIntervalState arg)Construct a new builder initialized from specifiedStatIntervalState.TotalBuilder(Total base)Construct a builder initialized with state from specifiedTotal.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TotalBuilderaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Total> augmentation)Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Total>>
E$$augmentation(Class<E$$> augmentationType)Return the specified augmentation, if it is present in this builder.@NonNull Totalbuild()A newTotalinstance.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)Set fields from given grouping argument.PercentagegetAvg()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getAvg().PercentagegetInstant()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getInstant().StatIntervalgetInterval()Return current value associated with the property corresponding toStatIntervalState.getInterval().PercentagegetMax()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getMax().Timeticks64getMaxTime()Return current value associated with the property corresponding toMinMaxTime.getMaxTime().PercentagegetMin()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getMin().Timeticks64getMinTime()Return current value associated with the property corresponding toMinMaxTime.getMinTime().TotalBuilderremoveAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Total>> augmentationType)Remove an augmentation from this builder's product.TotalBuildersetAvg(Percentage value)Set the property corresponding toAvgMinMaxInstantStatsPct.getAvg()to the specified value.TotalBuildersetInstant(Percentage value)Set the property corresponding toAvgMinMaxInstantStatsPct.getInstant()to the specified value.TotalBuildersetInterval(StatInterval value)Set the property corresponding toStatIntervalState.getInterval()to the specified value.TotalBuildersetMax(Percentage value)Set the property corresponding toAvgMinMaxInstantStatsPct.getMax()to the specified value.TotalBuildersetMaxTime(Timeticks64 value)Set the property corresponding toMinMaxTime.getMaxTime()to the specified value.TotalBuildersetMin(Percentage value)Set the property corresponding toAvgMinMaxInstantStatsPct.getMin()to the specified value.TotalBuildersetMinTime(Timeticks64 value)Set the property corresponding toMinMaxTime.getMinTime()to the specified value.
-
-
-
Constructor Detail
-
TotalBuilder
public TotalBuilder()
Construct an empty builder.
-
TotalBuilder
public TotalBuilder(AvgMinMaxInstantStatsPct arg)
Construct a new builder initialized from specifiedAvgMinMaxInstantStatsPct.- Parameters:
arg- AvgMinMaxInstantStatsPct from which the builder should be initialized
-
TotalBuilder
public TotalBuilder(StatIntervalState arg)
Construct a new builder initialized from specifiedStatIntervalState.- Parameters:
arg- StatIntervalState from which the builder should be initialized
-
TotalBuilder
public TotalBuilder(MinMaxTime arg)
Construct a new builder initialized from specifiedMinMaxTime.- Parameters:
arg- MinMaxTime 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
-
getAvg
public Percentage getAvg()
Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getAvg().- Returns:
- current value
-
getInstant
public Percentage getInstant()
Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getInstant().- Returns:
- current value
-
getInterval
public StatInterval getInterval()
Return current value associated with the property corresponding toStatIntervalState.getInterval().- Returns:
- current value
-
getMax
public Percentage getMax()
Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getMax().- Returns:
- current value
-
getMaxTime
public Timeticks64 getMaxTime()
Return current value associated with the property corresponding toMinMaxTime.getMaxTime().- Returns:
- current value
-
getMin
public Percentage getMin()
Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getMin().- Returns:
- current value
-
getMinTime
public Timeticks64 getMinTime()
Return current value associated with the property corresponding toMinMaxTime.getMinTime().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Total>> 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
-
setAvg
public TotalBuilder setAvg(Percentage value)
Set the property corresponding toAvgMinMaxInstantStatsPct.getAvg()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInstant
public TotalBuilder setInstant(Percentage value)
Set the property corresponding toAvgMinMaxInstantStatsPct.getInstant()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInterval
public TotalBuilder setInterval(StatInterval value)
Set the property corresponding toStatIntervalState.getInterval()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMax
public TotalBuilder setMax(Percentage value)
Set the property corresponding toAvgMinMaxInstantStatsPct.getMax()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMaxTime
public TotalBuilder setMaxTime(Timeticks64 value)
Set the property corresponding toMinMaxTime.getMaxTime()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMin
public TotalBuilder setMin(Percentage value)
Set the property corresponding toAvgMinMaxInstantStatsPct.getMin()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMinTime
public TotalBuilder setMinTime(Timeticks64 value)
Set the property corresponding toMinMaxTime.getMinTime()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public TotalBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Total> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public TotalBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Total>> 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
-
-