Class TemperatureBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.platform.rev210118.platform.component.temp.state.TemperatureBuilder
Class that builds
Temperature 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:
Temperature createTemperature(int fooXyzzy, int barBaz) {
return new TemperatureBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Temperature, 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 specifiedMinMaxTime.Construct a new builder initialized from specifiedStatIntervalState.Construct a builder initialized with state from specifiedTemperature.Construct a new builder initialized from specifiedPlatformComponentTempAlarmState.Construct a new builder initialized from specifiedAvgMinMaxInstantStatsPrecision1Celsius. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Temperature> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Temperature>>
E$$augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Temperaturebuild()A newTemperatureinstance.static @NonNull Temperatureempty()Get empty instance of Temperature.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPlatformComponentTempAlarmState.getAlarmSeverity().Return current value associated with the property corresponding toPlatformComponentTempAlarmState.getAlarmStatus().org.opendaylight.yangtools.yang.common.Uint32Return current value associated with the property corresponding toPlatformComponentTempAlarmState.getAlarmThreshold().org.opendaylight.yangtools.yang.common.Decimal64getAvg()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getAvg().org.opendaylight.yangtools.yang.common.Decimal64Return current value associated with the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getInstant().Return current value associated with the property corresponding toStatIntervalState.getInterval().org.opendaylight.yangtools.yang.common.Decimal64getMax()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getMax().Return current value associated with the property corresponding toMinMaxTime.getMaxTime().org.opendaylight.yangtools.yang.common.Decimal64getMin()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getMin().Return current value associated with the property corresponding toMinMaxTime.getMinTime().removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Temperature>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toPlatformComponentTempAlarmState.getAlarmSeverity()to the specified value.setAlarmStatus(Boolean value) Set the property corresponding toPlatformComponentTempAlarmState.getAlarmStatus()to the specified value.setAlarmThreshold(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toPlatformComponentTempAlarmState.getAlarmThreshold()to the specified value.setAvg(org.opendaylight.yangtools.yang.common.Decimal64 value) Set the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getAvg()to the specified value.setInstant(org.opendaylight.yangtools.yang.common.Decimal64 value) Set the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getInstant()to the specified value.setInterval(StatInterval value) Set the property corresponding toStatIntervalState.getInterval()to the specified value.setMax(org.opendaylight.yangtools.yang.common.Decimal64 value) Set the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getMax()to the specified value.setMaxTime(Timeticks64 value) Set the property corresponding toMinMaxTime.getMaxTime()to the specified value.setMin(org.opendaylight.yangtools.yang.common.Decimal64 value) Set the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getMin()to the specified value.setMinTime(Timeticks64 value) Set the property corresponding toMinMaxTime.getMinTime()to the specified value.
-
Constructor Details
-
TemperatureBuilder
public TemperatureBuilder()Construct an empty builder. -
TemperatureBuilder
Construct a new builder initialized from specifiedAvgMinMaxInstantStatsPrecision1Celsius.- Parameters:
arg- AvgMinMaxInstantStatsPrecision1Celsius from which the builder should be initialized
-
TemperatureBuilder
Construct a new builder initialized from specifiedStatIntervalState.- Parameters:
arg- StatIntervalState from which the builder should be initialized
-
TemperatureBuilder
Construct a new builder initialized from specifiedMinMaxTime.- Parameters:
arg- MinMaxTime from which the builder should be initialized
-
TemperatureBuilder
Construct a new builder initialized from specifiedPlatformComponentTempAlarmState.- Parameters:
arg- PlatformComponentTempAlarmState from which the builder should be initialized
-
TemperatureBuilder
Construct a builder initialized with state from specifiedTemperature.- Parameters:
base- Temperature 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 Temperature.- Returns:
- An empty
Temperature
-
getAlarmSeverity
Return current value associated with the property corresponding toPlatformComponentTempAlarmState.getAlarmSeverity().- Returns:
- current value
-
getAlarmStatus
Return current value associated with the property corresponding toPlatformComponentTempAlarmState.getAlarmStatus().- Returns:
- current value
-
getAlarmThreshold
public org.opendaylight.yangtools.yang.common.Uint32 getAlarmThreshold()Return current value associated with the property corresponding toPlatformComponentTempAlarmState.getAlarmThreshold().- Returns:
- current value
-
getAvg
public org.opendaylight.yangtools.yang.common.Decimal64 getAvg()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getAvg().- Returns:
- current value
-
getInstant
public org.opendaylight.yangtools.yang.common.Decimal64 getInstant()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getInstant().- Returns:
- current value
-
getInterval
Return current value associated with the property corresponding toStatIntervalState.getInterval().- Returns:
- current value
-
getMax
public org.opendaylight.yangtools.yang.common.Decimal64 getMax()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getMax().- Returns:
- current value
-
getMaxTime
Return current value associated with the property corresponding toMinMaxTime.getMaxTime().- Returns:
- current value
-
getMin
public org.opendaylight.yangtools.yang.common.Decimal64 getMin()Return current value associated with the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.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<Temperature>> 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
-
setAlarmSeverity
Set the property corresponding toPlatformComponentTempAlarmState.getAlarmSeverity()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setAlarmStatus
Set the property corresponding toPlatformComponentTempAlarmState.getAlarmStatus()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setAlarmThreshold
Set the property corresponding toPlatformComponentTempAlarmState.getAlarmThreshold()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setAvg
Set the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.getAvg()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setInstant
Set the property corresponding toAvgMinMaxInstantStatsPrecision1Celsius.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 toAvgMinMaxInstantStatsPrecision1Celsius.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 toAvgMinMaxInstantStatsPrecision1Celsius.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 TemperatureBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Temperature> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public TemperatureBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Temperature>> 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 newTemperatureinstance.- Returns:
- A new
Temperatureinstance.
-