net.degreedays.api.data.impl

Class HeatingDegreeDaysCalculation

java.lang.Object

net.degreedays.api.data.Calculation

net.degreedays.api.data.impl.HeatingDegreeDaysCalculation

All Implemented Interfaces:

java.io.Serializable

public final class HeatingDegreeDaysCalculation
extends Calculation
implements java.io.Serializable

A type of Calculation that specifies that heating degree days should be calculated and that holds the base temperature that they should be calculated to.

Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.

Constructor Summary

Constructors

Constructor and Description
HeatingDegreeDaysCalculation(Temperature baseTemperature) Constructs a HeatingDegreeDaysCalculation object with the specified base temperature.

Method Summary

Modifier and Type	Method and Description
Temperature	baseTemperature() Returns the non-null base temperature of the heating-degree-days calculation.
java.lang.String	toString() Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

Methods inherited from class net.degreedays.api.data.Calculation

coolingDegreeDays, equals, hashCode, heatingDegreeDays

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HeatingDegreeDaysCalculation

public HeatingDegreeDaysCalculation(Temperature baseTemperature)

Constructs a HeatingDegreeDaysCalculation object with the specified base temperature.

Parameters:

baseTemperature - the base temperature that the heating degree days should be calculated to. Cannot be null.

Throws:

java.lang.NullPointerException - if baseTemperature is null.

Method Detail

baseTemperature

public Temperature baseTemperature()

Returns the non-null base temperature of the heating-degree-days calculation.

toString

public java.lang.String toString()

Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object