|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.degreedays.api.data.Breakdown
public abstract class Breakdown
Defines how a set of degree days should be broken down (e.g. daily, weekly, or monthly), and the period in time they should cover.
To create a Breakdown
object, see the static factory
methods on the DatedBreakdown
and AverageBreakdown
subclasses.
This abstract class is not designed to be extended by third-party code, which is why it does not have an accessible constructor.
All concrete subclasses of this abstract class are immutable. You can safely reuse them and call them from multiple threads at once.
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
Two Breakdown objects are equal if they have the same class
and the same configuration. |
abstract DayRange |
getFullRangeOrNull(DayRange availableDataRange)
Returns the range of days that this breakdown would cover given source data covering availableDataRange , or null if
availableDataRange would not be enough for this breakdown. |
int |
hashCode()
Overridden to ensure consistency with equals . |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public abstract DayRange getFullRangeOrNull(DayRange availableDataRange)
availableDataRange
, or null
if
availableDataRange
would not be enough for this breakdown.
availableDataRange
- the non-null range of temperature data
available (or the available range of daily degree-day data if
summing daily degree days into a different breakdown).
java.lang.NullPointerException
- if availableDataRange
is
null
.public final boolean equals(java.lang.Object obj)
Breakdown
objects are equal if they have the same class
and the same configuration.
equals
in class java.lang.Object
public final int hashCode()
equals
.
hashCode
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |