Class HardwareInterruptBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.cpu.state.HardwareInterruptBuilder
Class that builds
HardwareInterrupt 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:
HardwareInterrupt createHardwareInterrupt(int fooXyzzy, int barBaz) {
return new HardwareInterruptBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of HardwareInterrupt, 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.Construct a new builder initialized from specifiedAvgMinMaxInstantStatsPct.Construct a new builder initialized from specifiedMinMaxTime.Construct a new builder initialized from specifiedStatIntervalState.Construct a builder initialized with state from specifiedHardwareInterrupt. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<HardwareInterrupt> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<HardwareInterrupt>>
E$$augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull HardwareInterruptbuild()A newHardwareInterruptinstance.static @NonNull HardwareInterruptempty()Get empty instance of HardwareInterrupt.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getAvg()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getAvg().Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getInstant().Return current value associated with the property corresponding toStatIntervalState.getInterval().getMax()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getMax().Return current value associated with the property corresponding toMinMaxTime.getMaxTime().getMin()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getMin().Return current value associated with the property corresponding toMinMaxTime.getMinTime().removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HardwareInterrupt>> augmentationType) Remove an augmentation from this builder's product.setAvg(Percentage value) Set the property corresponding toAvgMinMaxInstantStatsPct.getAvg()to the specified value.setInstant(Percentage value) Set the property corresponding toAvgMinMaxInstantStatsPct.getInstant()to the specified value.setInterval(StatInterval value) Set the property corresponding toStatIntervalState.getInterval()to the specified value.setMax(Percentage value) Set the property corresponding toAvgMinMaxInstantStatsPct.getMax()to the specified value.setMaxTime(Timeticks64 value) Set the property corresponding toMinMaxTime.getMaxTime()to the specified value.setMin(Percentage value) Set the property corresponding toAvgMinMaxInstantStatsPct.getMin()to the specified value.setMinTime(Timeticks64 value) Set the property corresponding toMinMaxTime.getMinTime()to the specified value.
-
Constructor Details
-
HardwareInterruptBuilder
public HardwareInterruptBuilder()Construct an empty builder. -
HardwareInterruptBuilder
Construct a new builder initialized from specifiedAvgMinMaxInstantStatsPct.- Parameters:
arg- AvgMinMaxInstantStatsPct from which the builder should be initialized
-
HardwareInterruptBuilder
Construct a new builder initialized from specifiedStatIntervalState.- Parameters:
arg- StatIntervalState from which the builder should be initialized
-
HardwareInterruptBuilder
Construct a new builder initialized from specifiedMinMaxTime.- Parameters:
arg- MinMaxTime from which the builder should be initialized
-
HardwareInterruptBuilder
Construct a builder initialized with state from specifiedHardwareInterrupt.- Parameters:
base- HardwareInterrupt 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 HardwareInterrupt.- Returns:
- An empty
HardwareInterrupt
-
getAvg
Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getAvg().- Returns:
- current value
-
getInstant
Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getInstant().- Returns:
- current value
-
getInterval
Return current value associated with the property corresponding toStatIntervalState.getInterval().- Returns:
- current value
-
getMax
Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getMax().- Returns:
- current value
-
getMaxTime
Return current value associated with the property corresponding toMinMaxTime.getMaxTime().- Returns:
- current value
-
getMin
Return current value associated with the property corresponding toAvgMinMaxInstantStatsPct.getMin().- Returns:
- current value
-
getMinTime
Return current value associated with the property corresponding toMinMaxTime.getMinTime().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<HardwareInterrupt>> 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
Set the property corresponding toAvgMinMaxInstantStatsPct.getAvg()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInstant
Set the property corresponding toAvgMinMaxInstantStatsPct.getInstant()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInterval
Set the property corresponding toStatIntervalState.getInterval()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMax
Set the property corresponding toAvgMinMaxInstantStatsPct.getMax()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMaxTime
Set the property corresponding toMinMaxTime.getMaxTime()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMin
Set the property corresponding toAvgMinMaxInstantStatsPct.getMin()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setMinTime
Set the property corresponding toMinMaxTime.getMinTime()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public HardwareInterruptBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<HardwareInterrupt> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public HardwareInterruptBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HardwareInterrupt>> 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 newHardwareInterruptinstance.- Returns:
- A new
HardwareInterruptinstance.
-