A B C D E F G H I K L M N O P R S T U V W X Y

A

AccountKey - Class in net.degreedays.api
The shorter of the two access keys, the account key identifies a unique Degree Days.net API account.
AccountKey(String) - Constructor for class net.degreedays.api.AccountKey
Constructs an AccountKey object using the specified string account key or throws an IllegalArgumentException if the string is clearly invalid.
accountKey() - Method in class net.degreedays.api.processing.RequestSecurityInfo
 
add(String, DataSet) - Method in class net.degreedays.api.data.DataSets.Builder
Adds an association between a string key from a DataSpec in the request and a DataSet from the response.
add(DataSpec, DataSet) - Method in class net.degreedays.api.data.DataSets.Builder
Adds an association between a DataSpec from the request and a DataSet from the response, without dealing directly with the string keys that are used in the XML.
add(String, DataSpec) - Method in class net.degreedays.api.data.DataSpecs.CustomKeyBuilder
Adds a unique key and the DataSpec to be associated with it.
addFailure(String, Failure) - Method in class net.degreedays.api.data.DataSets.Builder
Adds an association between a string key from a DataSpec in the request and a Failure from the response.
addFailure(DataSpec, Failure) - Method in class net.degreedays.api.data.DataSets.Builder
Adds an association between a DataSpec from the request and a Failure from the response, without dealing directly with the string keys that are used in the XML.
addParam(String, String) - Method in class net.degreedays.api.processing.HttpRequest.Builder
Add a new parameter.
addSource(Source) - Method in class net.degreedays.api.data.LocationDataResponse.Builder
 
addSource(Source) - Method in class net.degreedays.api.data.LocationInfoResponse.Builder
 
addValue(DatedDataValue) - Method in class net.degreedays.api.data.DatedDataSet.Builder
Adds a DatedDataValue object.
after(Day) - Method in class net.degreedays.time.Day
Tests whether this Day comes later in time than the specified comparison Day.
annualAverage() - Method in class net.degreedays.api.data.AverageDataSet
Returns the non-null average annual value.
asRange() - Method in class net.degreedays.time.Day
Returns a non-null DayRange covering this Day only.
average(Calculation, AverageBreakdown) - Static method in class net.degreedays.api.data.DataSpec
Returns an non-null AverageDataSpec object with the specified Calculation and AverageBreakdown.
AverageBreakdown - Class in net.degreedays.api.data
Defines how a set of average degree days should be broken down, including the period in time they should cover.
AverageDataSet - Class in net.degreedays.api.data
Contains a set of average degree-day data generated to fulfil an AverageDataSpec for a specific Location.
AverageDataSet.Builder - Class in net.degreedays.api.data
A builder class for creating immutable AverageDataSet objects e.g. for testing purposes.
AverageDataSet.Builder() - Constructor for class net.degreedays.api.data.AverageDataSet.Builder
 
AverageDataSpec - Class in net.degreedays.api.data
Defines a specification for a set of average data such as 5-year-average degree days.
AverageDataSpec(Calculation, AverageBreakdown) - Constructor for class net.degreedays.api.data.AverageDataSpec
Constructs an AverageDataSpec object with the specified Calculation and AverageBreakdown.

B

baseTemperature() - Method in class net.degreedays.api.data.impl.CoolingDegreeDaysCalculation
Returns the non-null base temperature of the cooling-degree-days calculation.
baseTemperature() - Method in class net.degreedays.api.data.impl.HeatingDegreeDaysCalculation
Returns the non-null base temperature of the heating-degree-days calculation.
before(Day) - Method in class net.degreedays.time.Day
Tests whether this Day comes earlier in time than the specified comparison Day.
breakdown() - Method in class net.degreedays.api.data.AverageDataSpec
Returns the non-null AverageBreakdown that defines the way in which the degree days should be broken down and the period in time that they should cover.
Breakdown - Class in net.degreedays.api.data
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.
breakdown() - Method in class net.degreedays.api.data.DatedDataSpec
Returns the non-null DatedBreakdown object that defines the way in which the degree days should be broken down and the period in time that they should cover.
build() - Method in class net.degreedays.api.data.AverageDataSet.Builder
 
build() - Method in class net.degreedays.api.data.DataSets.Builder
Returns a new DataSets object created according to the specification held by this builder.
build() - Method in class net.degreedays.api.data.DataSpecs.CustomKeyBuilder
Creates a DataSpecs object with the configuration that is currently held by this builder.
build() - Method in class net.degreedays.api.data.DatedDataSet.Builder
 
build() - Method in class net.degreedays.api.data.LocationDataResponse.Builder
 
build() - Method in class net.degreedays.api.data.LocationInfoResponse.Builder
 
build() - Method in class net.degreedays.api.data.Source.Builder
 
build() - Method in class net.degreedays.api.data.Station.Builder
 
build() - Method in class net.degreedays.api.Failure.Builder
 
build() - Method in class net.degreedays.api.FailureResponse.Builder
 
build() - Method in class net.degreedays.api.processing.HttpRequest.Builder
 
build() - Method in class net.degreedays.api.processing.RequestSecurityInfo.Builder
 
build() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
build() - Method in class net.degreedays.api.RateLimit.Builder
 
build() - Method in class net.degreedays.api.ResponseMetadata.Builder
 
BytesToEncodedString - Interface in net.degreedays.api.processing
 

C

calculation() - Method in class net.degreedays.api.data.AverageDataSpec
Returns the non-null Calculation object that defines the way in which the degree days should be calculated in terms of their base temperature and whether they should be heating degree days or cooling degree days.
Calculation - Class in net.degreedays.api.data
Defines how degree days should be calculated e.g. HDD or CDD to a specific base temperature.
calculation() - Method in class net.degreedays.api.data.DatedDataSpec
Returns the non-null Calculation object that defines the way in which the degree days should be calculated in terms of their base temperature and whether they should be heating degree days or cooling degree days.
celsius(double) - Static method in class net.degreedays.api.data.Temperature
Returns a non-null Temperature object with the specified Celsius temperature rounded to the nearest 0.1 C.
CELSIUS - Static variable in class net.degreedays.api.data.TemperatureUnit
For the Celsius temperature scale.
clear() - Method in class net.degreedays.api.SecurityKey
Clears all information stored internally to reduce the chances of a representation of the underlying security key remaining in memory.
close() - Method in class net.degreedays.api.processing.HttpResponseStream
Closes the HttpResponseStream.stream(), wrapping any IOException in a TransportException.
code() - Method in class net.degreedays.api.Failure
Returns the non-null, non-empty code associated with this failure.
compareTo(Object) - Method in class net.degreedays.time.Day
Compares two Day objects for chronological ordering.
compareTo(Object) - Method in class net.degreedays.time.StartOfMonth
 
compareTo(Object) - Method in class net.degreedays.time.StartOfYear
 
contains(Day) - Method in class net.degreedays.time.DayRange
Returns true if the specified Day is fully contained within this DayRange; false otherwise.
contains(DayRange) - Method in class net.degreedays.time.DayRange
Returns true if the specified DayRange is contained within this DayRange; false otherwise.
coolingDegreeDays(Temperature) - Static method in class net.degreedays.api.data.Calculation
Returns a non-null CoolingDegreeDaysCalculation object with the specified base temperature.
CoolingDegreeDaysCalculation - Class in net.degreedays.api.data.impl
A type of Calculation that specifies that cooling degree days should be calculated and that holds the base temperature that they should be calculated to.
CoolingDegreeDaysCalculation(Temperature) - Constructor for class net.degreedays.api.data.impl.CoolingDegreeDaysCalculation
Constructs a CoolingDegreeDaysCalculation object with the specified base temperature.
count() - Method in class net.degreedays.api.data.DataSpecs
Returns the number of DataSpec objects held by this DataSpecs - always greater than zero.
count() - Method in class net.degreedays.time.MaybeEmptyDayRanges
 
countryCode() - Method in class net.degreedays.api.data.impl.PostalCodeLocation
Returns the non-null two-letter upper-case ISO 3166-1-alpha-2 country code of the country that the postal code belongs to.

D

daily(Period) - Static method in class net.degreedays.api.data.DatedBreakdown
Returns a non-null DailyBreakdown object that specifies daily degree days covering the specified period in time.
DailyBreakdown - Class in net.degreedays.api.data.impl
A type of DatedBreakdown used to specify that degree days should be broken down on a daily basis and cover a specific Period in time.
DailyBreakdown(Period) - Constructor for class net.degreedays.api.data.impl.DailyBreakdown
Constructs a DailyBreakdown object that specifies daily degree days covering the specified period in time.
DataApi - Class in net.degreedays.api.data
Provides easy, type-safe access to the API's data-related operations.
DataApi(RequestProcessor) - Constructor for class net.degreedays.api.data.DataApi
Constructs a DataApi object that uses the specified RequestProcessor internally.
dataApi() - Method in class net.degreedays.api.DegreeDaysApi
Returns a non-null DataApi object, providing easy, type-safe access to the API's data-related operations.
DataSet - Class in net.degreedays.api.data
Contains a set of degree-day data generated to fulfil a DataSpec for a specific Location.
DataSets - Class in net.degreedays.api.data
Contains all sets of degree-day data generated to fulfil the DataSpecs for a specific Location.
dataSets() - Method in class net.degreedays.api.data.LocationDataResponse
Returns the non-null DataSets object containing the sets of data generated to fulfil the DataSpecs from the LocationDataRequest that led to this response.
DataSets.Builder - Class in net.degreedays.api.data
A builder class for creating immutable DataSets objects e.g. for testing purposes.
DataSets.Builder(DataSpecs) - Constructor for class net.degreedays.api.data.DataSets.Builder
Note that this constructor would only usually be called by a ResponseParser, and that's not an interface that you are likely to need to deal with unless you are replacing parts of the framework.
DataSpec - Class in net.degreedays.api.data
Defines a specification of a single set of degree-day data in all aspects other than the location that the data should be generated for.
DataSpecs - Class in net.degreedays.api.data
Defines up to 100 sets of data that should be generated to fulfil a LocationDataRequest.
DataSpecs(DataSpec[]) - Constructor for class net.degreedays.api.data.DataSpecs
Constructs a DataSpecs object containing the specified DataSpec objects.
DataSpecs(Collection) - Constructor for class net.degreedays.api.data.DataSpecs
Constructs a DataSpecs object containing the specified DataSpec objects.
DataSpecs(DataSpec) - Constructor for class net.degreedays.api.data.DataSpecs
Constructs a DataSpecs object containing just the one specified DataSpec object.
dataSpecs() - Method in class net.degreedays.api.data.LocationDataRequest
Returns the non-null DataSpecs object that specifies how the set(s) of data should be calculated and broken down.
dataSpecs() - Method in class net.degreedays.api.data.LocationInfoRequest
Returns the non-null DataSpecs object that specifies the data that is desired from the specified location.
DataSpecs.CustomKeyBuilder - Class in net.degreedays.api.data
For advanced use, this provides a way to create a DataSpecs object with custom keys.
DataSpecs.CustomKeyBuilder() - Constructor for class net.degreedays.api.data.DataSpecs.CustomKeyBuilder
Constructs an empty DataSpecs.CustomKeyBuilder.
DataTransformException - Exception in net.degreedays.api.data
Indicates that this client library could not transform a set of data into one with a different breakdown.
DataValue - Class in net.degreedays.api.data
Contains a degree-day value (either HDD or CDD) and an approximate indication of its accuracy.
dated(Calculation, DatedBreakdown) - Static method in class net.degreedays.api.data.DataSpec
Returns a non-null DatedDataSpec object with the specified Calculation and DatedBreakdown.
DatedBreakdown - Class in net.degreedays.api.data
Defines how a set of dated degree days should be broken down, including the period in time they should cover.
DatedDataSet - Class in net.degreedays.api.data
Contains a set of dated data (e.g. daily/weekly/monthly degree days) generated to fulfil a DatedDataSpec for a specific Location.
DatedDataSet.Builder - Class in net.degreedays.api.data
A builder class for creating immutable DatedDataSet objects e.g. for testing purposes.
DatedDataSet.Builder() - Constructor for class net.degreedays.api.data.DatedDataSet.Builder
 
DatedDataSpec - Class in net.degreedays.api.data
Defines a specification for a set of dated data such as daily, weekly, or monthly degree days covering a specific period in time.
DatedDataSpec(Calculation, DatedBreakdown) - Constructor for class net.degreedays.api.data.DatedDataSpec
Constructs a DatedDataSpec object with the specified Calculation and DatedBreakdown.
DatedDataValue - Class in net.degreedays.api.data
Contains a degree-day value for a specific dated period (a single day or a range of days like a specific week, month, or year).
DateFormatter - Interface in net.degreedays.api.processing
Formats dates as strings.
Day - Class in net.degreedays.time
A time-zone-independent representation of a YYYY-MM-DD date.
Day(int, int, int) - Constructor for class net.degreedays.time.Day
Constructs a Day object representing a date with the specified year, month, and day.
dayAt(int) - Method in class net.degreedays.time.DayRange
Returns the non-null Day at the specified zero-based index within this DayRange.
dayCount() - Method in class net.degreedays.time.DayRange
Returns the number of days covered by this DayRange (always 1 or more).
dayOfMonth() - Method in class net.degreedays.time.Day
Returns a one-based number indicating the day-of-the-month component of this Day object.
dayOfMonth() - Method in class net.degreedays.time.StartOfMonth
Returns a number between 1 and 28 (inclusive) indicating which day should be taken as the first of the month.
dayOfMonth() - Method in class net.degreedays.time.StartOfYear
Returns the number between 1 and the number of days in StartOfYear.monthOfYear() (inclusive) indicating which day in monthOfYear() is the first day of the "year" defined by this StartOfYear.
dayOfWeek() - Method in class net.degreedays.time.Day
Returns the non-null day-of-the-week of this Day object.
DayOfWeek - Class in net.degreedays.time
 
dayOfYear() - Method in class net.degreedays.time.Day
Returns a number between 1 and 366 inclusive (365 for non-leap years) indicating the day-of-the-year of this Day object.
dayRange() - Method in class net.degreedays.api.data.DatedDataValue
Returns a non-null DayRange object indicating the period in time that this DatedDataValue covers.
dayRange() - Method in class net.degreedays.api.data.impl.DayRangePeriod
Returns the non-null DayRange object that specifies the day(s) that this period covers.
dayRange(DayRange) - Static method in class net.degreedays.api.data.Period
Returns a non-null DayRangePeriod object that specifies the period covered by dayRange.
DayRange - Class in net.degreedays.time
Specifies a range of one or more days.
DayRange(Day, Day) - Constructor for class net.degreedays.time.DayRange
Constructs a DayRange object that starts on the specified first day and ends on the specified last day.
DayRangePeriod - Class in net.degreedays.api.data.impl
A type of Period that is defined explicitly in terms of the range of days that it covers.
DayRangePeriod(DayRange) - Constructor for class net.degreedays.api.data.impl.DayRangePeriod
Constructs a DayRangePeriod object that specifies the period covered by dayRange.
DayRanges - Class in net.degreedays.time
 
daysAfter(Day) - Method in class net.degreedays.time.Day
 
daysBefore(Day) - Method in class net.degreedays.time.Day
 
DegreeDaysApi - Class in net.degreedays.api
The starting point for all API operations. If you're new to this API, read the docs for this class first.
DegreeDaysApi(AccountKey, SecurityKey) - Constructor for class net.degreedays.api.DegreeDaysApi
Constructs a DegreeDaysApi object that internally uses a default RequestProcessor configured with the specified access keys.
DegreeDaysApi(RequestProcessor) - Constructor for class net.degreedays.api.DegreeDaysApi
Constructs a DegreeDaysApi object that internally uses the specified RequestProcessor.
DegreeDaysApiException - Exception in net.degreedays.api
Superclass of all the API exceptions that you are likely to want to catch explicitly.
dispatch(HttpRequest) - Method in interface net.degreedays.api.processing.HttpRequestDispatcher
Calling code is responsible for closing the stream that this returns.
displayName() - Method in class net.degreedays.api.data.Station
Returns a non-null, non-empty string representing the name of the weather station.
Distance - Class in net.degreedays.geo
Defines a distance in terms of its numeric value and its unit of measurement (e.g.
Distance(double, DistanceUnit) - Constructor for class net.degreedays.geo.Distance
Constructs a new Distance object with the specified value and unit of measurement.
distanceFromTarget() - Method in class net.degreedays.api.data.Source
Returns the non-null distance of the Source.station() from the target location that was specified in the original request for data.
distanceTo(LongLat) - Method in class net.degreedays.geo.LongLat
Returns a Distance object that represents the shortest distance along the surface of the Earth from this to the specified longLat.
DistanceUnit - Class in net.degreedays.geo
Defines the units of distance measurement with constants to represent metres, kilometres, feet, and miles.

E

east(Distance) - Method in class net.degreedays.geo.LongLat
Returns a LongLat object that represents a position the specified distance East of this.
elevation() - Method in class net.degreedays.api.data.Station
Returns the non-null elevation of the weather station.
encoded() - Method in class net.degreedays.api.processing.EncodedString
 
EncodedString - Class in net.degreedays.api.processing
 
EncodedString(String, String) - Constructor for class net.degreedays.api.processing.EncodedString
 
encoding() - Method in class net.degreedays.api.processing.EncodedString
 
endpoint() - Method in class net.degreedays.api.processing.RequestSecurityInfo
 
EndpointGetter - Interface in net.degreedays.api.processing
Gets an endpoint URL for a request, maybe returning different endpoints for different types of request.
equals(Object) - Method in class net.degreedays.api.AccountKey
An AccountKey object can only be equal to an AccountKey object with an identical canonical string account key.
equals(Object) - Method in class net.degreedays.api.data.AverageDataSet
Returns true if o is an AverageDataSet containing equal values and calculated from data covering an equal period in time.
equals(Object) - Method in class net.degreedays.api.data.Breakdown
Two Breakdown objects are equal if they have the same class and the same configuration.
equals(Object) - Method in class net.degreedays.api.data.Calculation
Two Calculation objects are equal if they have the same class and the same configuration.
equals(Object) - Method in class net.degreedays.api.data.DataSets
A DataSets object is equal to another DataSets object with an equal DataSet for each DataSpec that it was created with.
equals(Object) - Method in class net.degreedays.api.data.DataSpec
Two DataSpec objects are equal if they have the same class and the same configuration.
equals(Object) - Method in class net.degreedays.api.data.DataSpecs
Two DataSpecs objects are equal if they contain the same set of unique DataSpec objects - neither keys nor the order of keys make any difference.
equals(Object) - Method in class net.degreedays.api.data.DataValue
Returns true if o is a DataValue object of the same type as this with an equal DataValue.value() and DataValue.percentageEstimated().
equals(Object) - Method in class net.degreedays.api.data.DatedDataSet
Returns true if o is a DatedDataSet containing equal values covering equal dates, and with an equal DatedDataSet.percentageEstimated().
equals(Object) - Method in class net.degreedays.api.data.DatedDataValue
Returns true if o is a DatedDataValue object with an equal value(), percentageEstimated(), and DatedDataValue.dayRange().
equals(Object) - Method in class net.degreedays.api.data.Location
Two Location objects are equal if it can be ascertained that they both represent the exact same weather station(s) or geographic location, and that two requests for data, one with each Location and identical in every other respect, would return identical data.
equals(Object) - Method in class net.degreedays.api.data.LocationDataRequest
Two LocationDataRequest objects are equal if it can be ascertained that they are specifying the same set(s) of data from the same location.
equals(Object) - Method in class net.degreedays.api.data.LocationDataResponse
Returns true if o is a LocationDataResponse with equal values for everything apart from the metadata() (which is not considered in the equality test).
equals(Object) - Method in class net.degreedays.api.data.LocationInfoRequest
Two LocationInfoRequest objects are equal if it can be ascertained that they are specifying the same set(s) of data from the same location.
equals(Object) - Method in class net.degreedays.api.data.LocationInfoResponse
Returns true if o is a LocationInfoResponse with equal values for everything apart from the metadata() (which is not considered in the equality test).
equals(Object) - Method in class net.degreedays.api.data.Period
Two Period objects are equal if it can be ascertained that they will always represent the same period in time as each other when compared at the same time and in the same context.
equals(Object) - Method in class net.degreedays.api.data.Source
Returns true if o is a Source object with equal fields to this.
equals(Object) - Method in class net.degreedays.api.data.Station
Returns true if o is a Station object with equal fields to this.
equals(Object) - Method in class net.degreedays.api.data.Temperature
Two Temperature objects can only be equal if they have the same units and temperature value (value comparisons being made after any rounding).
equals(Object) - Method in class net.degreedays.api.Failure
A Failure can only be equal to another Failure with an equal Failure.code() and Failure.message().
equals(Object) - Method in class net.degreedays.api.FailureResponse
Returns true if o is a FailureResponse with an equal FailureResponse.failure() (the metadata() is not considered in the equality test).
equals(Object) - Method in class net.degreedays.api.processing.EncodedString
 
equals(Object) - Method in class net.degreedays.api.processing.HttpRequest
Returns true if o is an HttpRequest object with an equal URL and equal parameters, irrespective of the order of the parameter names returned by HttpRequest.getParamNames().
equals(Object) - Method in class net.degreedays.api.processing.RequestSecurityInfo
Returns true if o is a RequestSecurityInfo object with equal properties.
equals(Object) - Method in class net.degreedays.api.processing.Signature
 
equals(Object) - Method in class net.degreedays.api.RateLimit
Returns true if o is a RateLimit object with equal properties.
equals(Object) - Method in class net.degreedays.api.SecurityKey
A SecurityKey object can only be equal to a SecurityKey object based around the same canonical security key.
equals(Object) - Method in class net.degreedays.geo.Distance
Returns true if o is a Distance object with an equal unit and an equal value.
equals(Object) - Method in class net.degreedays.geo.LongLat
Returns true if o is a LongLat object with the same LongLat.longitude() and LongLat.latitude() values as this.
equals(Object) - Method in class net.degreedays.time.Day
Two Day objects are equal if they represent the same date.
equals(Object) - Method in class net.degreedays.time.DayRange
Returns true if o is a DayRange covering exactly the same days as this DayRange; false otherwise.
equals(Object) - Method in class net.degreedays.time.MaybeEmptyDayRanges
 
equals(Object) - Method in class net.degreedays.time.StartOfMonth
Returns true if o is a StartOfMonth object representing the same day in the month as this; false otherwise.
equals(Object) - Method in class net.degreedays.time.StartOfYear
Returns true if o is a StartOfYear object representing the same day of the year as this; false otherwise.

F

fahrenheit(double) - Static method in class net.degreedays.api.data.Temperature
Returns a non-null Temperature object with the specified Fahrenheit temperature rounded to the nearest 0.1 F.
FAHRENHEIT - Static variable in class net.degreedays.api.data.TemperatureUnit
For the Fahrenheit temperature scale.
Failure - Class in net.degreedays.api
Contains details of a failure in the server-side processing of all or part of an API request.
failure() - Method in exception net.degreedays.api.FailureException
Returns the non-null Failure object containing details of the failure on the API's servers that led to this exception on the client.
failure() - Method in class net.degreedays.api.FailureResponse
Returns the non-null Failure object that contains details of the failure in the API's server-side processing of the request.
Failure.Builder - Class in net.degreedays.api
A builder class for creating immutable Failure objects e.g. for testing purposes.
Failure.Builder() - Constructor for class net.degreedays.api.Failure.Builder
 
FailureException - Exception in net.degreedays.api
Superclass of exceptions that indicate a Failure in the API's processing of all or part of a request.
FailureResponse - Class in net.degreedays.api
A type of API Response that indicates a failure in the server-side processing of a Request.
FailureResponse.Builder - Class in net.degreedays.api
A builder class for creating immutable FailureResponse objects e.g. for testing purposes.
FailureResponse.Builder() - Constructor for class net.degreedays.api.FailureResponse.Builder
 
feet(double) - Static method in class net.degreedays.geo.Distance
Returns a Distance object with the specified value and DistanceUnit.FEET as the unit of measurement.
FEET - Static variable in class net.degreedays.geo.DistanceUnit
 
first() - Method in class net.degreedays.time.DayRange
Returns the non-null first Day in this DayRange.
firstDay() - Method in class net.degreedays.api.data.DatedDataValue
Returns the non-null first Day of the period covered by this DatedDataValue.
firstDayOfWeek() - Method in class net.degreedays.api.data.impl.WeeklyBreakdown
Returns the non-null day of the week that should be the first of each weekly period.
firstYear() - Method in class net.degreedays.api.data.AverageDataSet
Returns the first year of the continuous set of data that was used to calculate the average figures.
format(Date) - Method in interface net.degreedays.api.processing.DateFormatter
 
FRIDAY - Static variable in class net.degreedays.time.DayOfWeek
 
fromCalendar(Calendar) - Static method in class net.degreedays.time.Day
 
fromDateUtc(Date) - Static method in class net.degreedays.time.Day
 
fromIsoIndex(int) - Static method in class net.degreedays.time.DayOfWeek
 
fromString(String) - Static method in class net.degreedays.time.Day
Parses a string date in ISO YYYY-MM-DD format (the format used by XML schema's date type), or YYYYMMDD format.
fromString(String) - Static method in class net.degreedays.time.DayOfWeek
 
fromString(String) - Static method in class net.degreedays.time.StartOfMonth
Parses a string representation of a StartOfMonth in ---DD format, the format used by XML Schema's gDay type (based on ISO 8601).
fromString(String) - Static method in class net.degreedays.time.StartOfYear
Parses a string representation of a StartOfYear in --MM-DD format, the format used by XML Schema's gMonthDay type (based on ISO 8601).
fullCalendarMonth() - Method in class net.degreedays.time.Day
 
fullCalendarMonthsWithin() - Method in class net.degreedays.time.DayRange
 
fullCalendarYear() - Method in class net.degreedays.time.Day
 
fullCalendarYearsWithin() - Method in class net.degreedays.time.DayRange
 
fullMonth(StartOfMonth) - Method in class net.degreedays.time.Day
 
fullMonthsWithin(StartOfMonth) - Method in class net.degreedays.time.DayRange
 
fullOrPartialCalendarMonthsWithin() - Method in class net.degreedays.time.DayRange
 
fullOrPartialCalendarYearsWithin() - Method in class net.degreedays.time.DayRange
 
fullOrPartialMonthsWithin(StartOfMonth) - Method in class net.degreedays.time.DayRange
 
fullOrPartialWeeksWithin(DayOfWeek) - Method in class net.degreedays.time.DayRange
 
fullOrPartialYearsWithin(StartOfYear) - Method in class net.degreedays.time.DayRange
 
fullRange() - Method in class net.degreedays.api.data.AverageDataSet
Returns a non-null DayRange object indicating the period of data from which this AverageDataSet's figures were calculated.
fullRange() - Method in class net.degreedays.api.data.DataSet
Returns a non-null DayRange object indicating the period of time that is covered by this DataSet.
fullRange() - Method in class net.degreedays.api.data.DatedDataSet
Returns a non-null DayRange object indicating the period of time that is covered by this DatedDataSet's values.
fullRange() - Method in class net.degreedays.time.DayRanges
 
fullRangeOrNull() - Method in class net.degreedays.time.MaybeEmptyDayRanges
 
fullWeek(DayOfWeek) - Method in class net.degreedays.time.Day
 
fullWeeksWithin(DayOfWeek) - Method in class net.degreedays.time.DayRange
 
fullYear(StartOfYear) - Method in class net.degreedays.time.Day
 
fullYears(Period) - Static method in class net.degreedays.api.data.AverageBreakdown
Returns a non-null FullYearsAverageBreakdown object that specifies average degree days derived from data covering full calendar years determined by the specified period.
FullYearsAverageBreakdown - Class in net.degreedays.api.data.impl
A type of AverageBreakdown used to specify that average-degree-day figures should be derived from data covering a specified number of full calendar years.
FullYearsAverageBreakdown(Period) - Constructor for class net.degreedays.api.data.impl.FullYearsAverageBreakdown
Constructs a FullYearsAverageBreakdown object that specifies average degree days derived from data covering full calendar years determined by the specified period.
fullYearsWithin(StartOfYear) - Method in class net.degreedays.time.DayRange
 

G

GeographicLocation - Class in net.degreedays.api.data
Defines a location in terms of a longitude/latitude or postal/zip code, leaving it to the API to find the nearest good weather station.
get(DataSpec) - Method in class net.degreedays.api.data.DataSets
Returns the DataSet that was generated to fulfil the specified DataSpec from the request, or throws a SourceDataException if no such DataSet could be generated.
get(String) - Method in class net.degreedays.api.data.DataSpecs
Returns the non-null DataSpec that has been assigned the specified string key.
get(int) - Method in class net.degreedays.time.MaybeEmptyDayRanges
 
getAverage(AverageDataSpec) - Method in class net.degreedays.api.data.DataSets
Convenience alternative to calling get(dataSpec) with an AverageDataSpec and then casting the result.
getBytes() - Method in class net.degreedays.api.processing.Signature
 
getBytes(String) - Method in interface net.degreedays.api.processing.StringToBytes
 
getBytes() - Method in class net.degreedays.api.SecurityKey
Returns a new, non-null byte array containing the canonical security key's characters encoded into bytes using the UTF-8 character set.
getBytesToEncodedString() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getDated(DatedDataSpec) - Method in class net.degreedays.api.data.DataSets
Convenience alternative to calling get(dataSpec) with a DatedDataSpec and then casting the result.
getDateFormatter() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getEmpty() - Static method in class net.degreedays.time.MaybeEmptyDayRanges
 
getEncodedString(byte[]) - Method in interface net.degreedays.api.processing.BytesToEncodedString
 
getEndpoint(Request) - Method in interface net.degreedays.api.processing.EndpointGetter
Returns the endpoint URL that should be used for the request passed in.
getEndpointGetter() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getFullRangeOrNull(DayRange) - Method in class net.degreedays.api.data.Breakdown
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.
getFullRangeOrNull(DayRange) - Method in class net.degreedays.api.data.DataSpecs
Returns the full range of days that this set of DataSpec objects would cover given temperature data covering availableDataRange, or null if availableDataRange is not of use to any of the DataSpec objects.
getFullRangeOrNull(DayRange) - Method in class net.degreedays.api.data.impl.DailyBreakdown
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.
getFullRangeOrNull(DayRange) - Method in class net.degreedays.api.data.impl.FullYearsAverageBreakdown
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.
getFullRangeOrNull(DayRange) - Method in class net.degreedays.api.data.impl.MonthlyBreakdown
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.
getFullRangeOrNull(DayRange) - Method in class net.degreedays.api.data.impl.WeeklyBreakdown
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.
getFullRangeOrNull(DayRange) - Method in class net.degreedays.api.data.impl.YearlyBreakdown
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.
getHttpRequestDispatcher() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getKey(DataSpec) - Method in class net.degreedays.api.data.DataSpecs
Returns the non-null, non-empty string key associated with dataSpec.
getKeys() - Method in class net.degreedays.api.data.DataSpecs
Gives access to the string keys that are assigned to the DataSpec objects stored within this DataSpecs.
getLocationData(LocationDataRequest) - Method in class net.degreedays.api.data.DataApi
Sends your request for data to the API servers, returning a non-null response containing data you requested, or throwing an appropriate subclass of DegreeDaysApiException if something goes wrong.
getLocationInfo(LocationInfoRequest) - Method in class net.degreedays.api.data.DataApi
A lightweight alternative to DataApi.getLocationData(LocationDataRequest) that returns info about the station(s) that would be used to satisfy an equivalent LocationDataRequest, but not the data itself.
getMessage() - Method in exception net.degreedays.api.FailureException
Overridden to return the FailureException.failure() details as the exception message.
getMinimumDayRange() - Method in class net.degreedays.api.data.impl.DayRangePeriod
Returns the non-null minimum day range that was specified using DayRangePeriod.withMinimumDayRange(net.degreedays.time.DayRange), or throws an IllegalStateException if no such range was specified (call DayRangePeriod.hasMinimumDayRange() before calling this).
getMinimumNumberOfValues() - Method in class net.degreedays.api.data.impl.LatestValuesPeriod
Returns the number, greater than zero, that was specified using LatestValuesPeriod.withMinimumNumberOfValues(int), or throws an IllegalStateException if no such number was specified (call LatestValuesPeriod.hasMinimumNumberOfValues() before calling this).
getParamNames() - Method in class net.degreedays.api.processing.HttpRequest
 
getParamValue(String) - Method in class net.degreedays.api.processing.HttpRequest
 
getRandomFactory() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getRequestToXml() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getResponseParser() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getSignature(byte[]) - Method in interface net.degreedays.api.processing.Signer
 
getSigner() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getSources() - Method in class net.degreedays.api.data.LocationDataResponse
Returns the non-null, non-empty array of source(s) (essentially weather stations) that were used to generate the data in this response.
getSources() - Method in class net.degreedays.api.data.LocationInfoResponse
Returns the non-null, non-empty array of source(s) (essentially weather stations) that would be used to generate data for an equivalent LocationDataResponse.
getStringToBytes() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getTimestampFactory() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
getValues() - Method in class net.degreedays.api.data.DatedDataSet
Returns an array of the DatedDataValue objects that make up this DatedDataSet.
getWithKey(String) - Method in class net.degreedays.api.data.DataSets
For unusual use cases, this enables you to access the DataSet objects using the string keys that are usually managed internally.
getWrappedXml(String, RequestSecurityInfo) - Method in interface net.degreedays.api.processing.XmlRequestWrapper
 
getXml(Request) - Method in interface net.degreedays.api.processing.RequestToXml
 
getXmlRequestWrapper() - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
greedyUnion(DayRange) - Method in class net.degreedays.time.DayRange
Returns the non-null DayRange that includes all the days within this DayRange, the specified DayRange, and any days between.
greedyUnion(Day) - Method in class net.degreedays.time.DayRange
Returns the non-null DayRange that includes all the days within this DayRange, the specified Day, and any days between.

H

hashCode() - Method in class net.degreedays.api.AccountKey
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.AverageDataSet
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.Breakdown
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.Calculation
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.DataSets
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.DataSpec
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.DataSpecs
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.DataValue
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.DatedDataSet
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.DatedDataValue
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.Location
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.LocationDataRequest
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.LocationDataResponse
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.LocationInfoRequest
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.LocationInfoResponse
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.Period
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.Source
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.Station
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.data.Temperature
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.Failure
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.FailureResponse
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.processing.EncodedString
 
hashCode() - Method in class net.degreedays.api.processing.HttpRequest
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.processing.RequestSecurityInfo
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.processing.Signature
 
hashCode() - Method in class net.degreedays.api.RateLimit
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.api.SecurityKey
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.geo.Distance
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.geo.LongLat
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.time.Day
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.time.DayRange
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.time.MaybeEmptyDayRanges
 
hashCode() - Method in class net.degreedays.time.StartOfMonth
Overridden to ensure consistency with equals.
hashCode() - Method in class net.degreedays.time.StartOfYear
Overridden to ensure consistency with equals.
hasMinimumDayRange() - Method in class net.degreedays.api.data.impl.DayRangePeriod
Returns true if this DayRangePeriod specifies the day(s) that must be covered by any data returned in response to a request for data covering this DayRangePeriod.
hasMinimumNumberOfValues() - Method in class net.degreedays.api.data.impl.LatestValuesPeriod
Returns true if this LatestValuesPeriod specifies the number of values that must be included in the response to a request for data covering this LatestValuesPeriod.
heatingDegreeDays(Temperature) - Static method in class net.degreedays.api.data.Calculation
Returns a non-null HeatingDegreeDaysCalculation object with the specified base temperature.
HeatingDegreeDaysCalculation - Class in net.degreedays.api.data.impl
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.
HeatingDegreeDaysCalculation(Temperature) - Constructor for class net.degreedays.api.data.impl.HeatingDegreeDaysCalculation
Constructs a HeatingDegreeDaysCalculation object with the specified base temperature.
HttpRequest - Class in net.degreedays.api.processing
 
HttpRequest.Builder - Class in net.degreedays.api.processing
A builder class for creating immutable HttpRequest objects.
HttpRequest.Builder() - Constructor for class net.degreedays.api.processing.HttpRequest.Builder
 
HttpRequestDispatcher - Interface in net.degreedays.api.processing
Implementations of this interface may choose to handle compressed responses by adding an Accept-Encoding header to the request sent to the server, and by ensuring that the InputStream returned by HttpRequestDispatcher.dispatch(HttpRequest) has been inflated.
HttpResponseStream - Class in net.degreedays.api.processing
 
HttpResponseStream(InputStream) - Constructor for class net.degreedays.api.processing.HttpResponseStream
 

I

id() - Method in class net.degreedays.api.data.Station
Returns the non-null, non-empty, canonical ID of the weather station.
in(DistanceUnit) - Method in class net.degreedays.geo.Distance
Returns a Distance object that represents this Distance converted into the specified unit of measurement.
indexOf(Day) - Method in class net.degreedays.time.DayRange
Returns the index of the specified Day within this DayRange, or -1 if it is not contained by this DayRange.
indexOf(DayRange) - Method in class net.degreedays.time.MaybeEmptyDayRanges
 
inFeet() - Method in class net.degreedays.geo.Distance
Returns a Distance object that represents this Distance converted into feet.
inKilometres() - Method in class net.degreedays.geo.Distance
Returns a Distance object that represents this Distance converted into kilometres.
inMetres() - Method in class net.degreedays.geo.Distance
Returns a Distance object that represents this Distance converted into metres.
inMiles() - Method in class net.degreedays.geo.Distance
Returns a Distance object that represents this Distance converted into miles.
intersectionOrNull(DayRange) - Method in class net.degreedays.time.DayRange
Returns a DayRange covering the days that are contained within both this DayRange and the specified DayRange, or null if there is no such intersection.
intValue() - Method in class net.degreedays.geo.Distance
Returns the distance value, rounded to the nearest integer.
InvalidRequestException - Exception in net.degreedays.api
Indicates that the API could not process a request because it was invalid in some way (e.g. authenticated with invalid access keys).
isCelsius() - Method in class net.degreedays.api.data.Temperature
Returns true if this temperature has CELSUS units.
isContiguous() - Method in class net.degreedays.time.DayRanges
Returns true if each contained range starts the day after the last left off.
isDailyData() - Method in class net.degreedays.api.data.DatedDataSet
Returns true if each of the values contained within this DatedDataSet covers one day.
isDueToInvalidRequestAccount() - Method in exception net.degreedays.api.InvalidRequestException
Returns true if this failure came in response to a request that was sent with an unrecognized account key.
isDueToInvalidRequestSignature() - Method in exception net.degreedays.api.InvalidRequestException
Returns true if this failure came in response to a request that was sent with an invalid signature, typically caused by a problem with the security key.
isDueToInvalidRequestTimestamp() - Method in exception net.degreedays.api.InvalidRequestException
Returns true if this failure came in response to a request that was sent with an invalid timestamp, typically caused by an out-of-sync clock on the client machine.
isDueToLocationNotRecognized() - Method in exception net.degreedays.api.data.LocationException
Returns true if this failure came in response to a request for data from a location that the API did not recognize as a weather station or real-world geographic location.
isDueToLocationNotSupported() - Method in exception net.degreedays.api.data.LocationException
Returns true if this failure came in response to a request for data from a location that is recognized but not currently supported by the API.
isDueToRateLimitOnLocationChanges() - Method in exception net.degreedays.api.RateLimitException
Returns true if this failure was caused by a rate limit on the number of times a location-limited account can change the location(s) that they access data from.
isDueToServiceTemporarilyDown() - Method in exception net.degreedays.api.ServiceException
Returns true if this failure was caused by a temporary problem preventing the API service from functioning properly (sorry!).
isDueToServiceUnexpectedError() - Method in exception net.degreedays.api.ServiceException
Returns true if this failure was caused by a unexpected error in the API service (sorry!).
isDueToSourceDataCoverage() - Method in exception net.degreedays.api.data.SourceDataException
Returns true if the requested data could not be generated because the source weather station's recorded temperature data did not cover the requested period in time.
isDueToSourceDataErrors() - Method in exception net.degreedays.api.data.SourceDataException
Returns true if the requested data could not be generated because of errors in the recorded temperature data of the source weather station.
isEmpty() - Method in class net.degreedays.time.MaybeEmptyDayRanges
 
isFahrenheit() - Method in class net.degreedays.api.data.Temperature
Returns true if this temperature has FAHRENHEIT units.
isFriday() - Method in class net.degreedays.time.DayOfWeek
 
isMonday() - Method in class net.degreedays.time.DayOfWeek
 
isMonthlyData() - Method in class net.degreedays.api.data.DatedDataSet
Returns true if each of the values contained within this DatedDataSet covers one month.
isoIndex() - Method in class net.degreedays.time.DayOfWeek
 
isSaturday() - Method in class net.degreedays.time.DayOfWeek
 
isSunday() - Method in class net.degreedays.time.DayOfWeek
 
isThursday() - Method in class net.degreedays.time.DayOfWeek
 
isTuesday() - Method in class net.degreedays.time.DayOfWeek
 
isWednesday() - Method in class net.degreedays.time.DayOfWeek
 
isWeeklyData() - Method in class net.degreedays.api.data.DatedDataSet
Returns true if each of the values contained within this DatedDataSet covers one week.
isYearlyData() - Method in class net.degreedays.api.data.DatedDataSet
Returns true if each of the values contained within this DatedDataSet covers one year.

K

kilometres(double) - Static method in class net.degreedays.geo.Distance
Returns a Distance object with the specified value and DistanceUnit.KILOMETRES as the unit of measurement.
KILOMETRES - Static variable in class net.degreedays.geo.DistanceUnit
 

L

last() - Method in class net.degreedays.time.DayRange
Returns the non-null last Day in this DayRange.
lastDay() - Method in class net.degreedays.api.data.DatedDataValue
Returns the non-null last Day of the period covered by this DatedDataValue.
lastYear() - Method in class net.degreedays.api.data.AverageDataSet
Returns the last year of the continuous set of data that was used to calculate the average figures.
latestValues(int) - Static method in class net.degreedays.api.data.Period
Returns a non-null LatestValuesPeriod object that automatically resolves to a date range including the latest available data and the specified number of degree-day values.
LatestValuesPeriod - Class in net.degreedays.api.data.impl
A type of Period that automatically resolves to a date range including the latest available data and the specified number of degree-day values.
LatestValuesPeriod(int) - Constructor for class net.degreedays.api.data.impl.LatestValuesPeriod
Constructs a LatestValuesPeriod object that automatically resolves to a date range including the latest available data and the specified number of degree-day values.
latitude() - Method in class net.degreedays.geo.LongLat
Returns the latitude: a number between -90 and 90 (both inclusive) representing the South/North coordinate.
Location - Class in net.degreedays.api.data
Defines a location for which degree days should be calculated.
location() - Method in class net.degreedays.api.data.LocationDataRequest
Returns the non-null Location object that specifies the location for which the degree days should be generated.
location() - Method in class net.degreedays.api.data.LocationInfoRequest
Returns the non-null Location object for which data is desired.
LocationDataRequest - Class in net.degreedays.api.data
Defines a request for one or more sets of degree-day data from a particular location.
LocationDataRequest(Location, DataSpecs) - Constructor for class net.degreedays.api.data.LocationDataRequest
Constructs a LocationDataRequest object with the specified Location and DataSpecs.
LocationDataResponse - Class in net.degreedays.api.data
Contains the degree-day data generated to fulfil a LocationDataRequest.
LocationDataResponse.Builder - Class in net.degreedays.api.data
A builder class for creating immutable LocationDataResponse objects e.g. for testing purposes.
LocationDataResponse.Builder() - Constructor for class net.degreedays.api.data.LocationDataResponse.Builder
 
LocationException - Exception in net.degreedays.api.data
Indicates a Failure in the API's processing of a request, caused by problems with the Location that the request specified.
LocationInfoRequest - Class in net.degreedays.api.data
Defines a request for info about the station(s) that would be used to fulfil an equivalent LocationDataRequest.
LocationInfoRequest(Location, DataSpecs) - Constructor for class net.degreedays.api.data.LocationInfoRequest
Constructs a LocationInfoRequest object with the specified Location and DataSpecs.
LocationInfoResponse - Class in net.degreedays.api.data
Contains the location/station-related info returned in response to a LocationInfoRequest.
LocationInfoResponse.Builder - Class in net.degreedays.api.data
A builder class for creating immutable LocationInfoResponse objects e.g. for testing purposes.
LocationInfoResponse.Builder() - Constructor for class net.degreedays.api.data.LocationInfoResponse.Builder
 
longitude() - Method in class net.degreedays.geo.LongLat
Returns the longitude: a number between -180 and 180 (both inclusive) representing the West/East coordinate, zeroed on a line passing to the rear of the Royal Observatory, Greenwich (near London in the UK).
longLat() - Method in class net.degreedays.api.data.impl.LongLatLocation
Returns the non-null longitude/latitude position of this LongLatLocation.
longLat(LongLat) - Static method in class net.degreedays.api.data.Location
Returns a non-null LongLatLocation object with the specified longitude and latitude position.
longLat() - Method in class net.degreedays.api.data.Station
Returns the non-null longitude/latitude location of the weather station.
LongLat - Class in net.degreedays.geo
Defines a geographic position in terms of its longitude and latitude coordinates.
LongLat(double, double) - Constructor for class net.degreedays.geo.LongLat
Constructs a LongLat object with the specified longitude and latitude (take care not to mix these up).
LongLatLocation - Class in net.degreedays.api.data.impl
Specifies a location in terms of longitude and latitude coordinates.
LongLatLocation(LongLat) - Constructor for class net.degreedays.api.data.impl.LongLatLocation
Constructs a LongLatLocation object with the specified longitude and latitude position.

M

MaybeEmptyDayRanges - Class in net.degreedays.time
 
message() - Method in class net.degreedays.api.Failure
Returns the non-null, non-empty message associated with this failure, providing explanatory information about the Failure.code() and what went wrong.
metadata() - Method in class net.degreedays.api.Response
Returns a non-null object containing metadata sent back with every response from the API servers, including details of the account's current rate limit.
method() - Method in class net.degreedays.api.processing.Signature
 
metres(double) - Static method in class net.degreedays.geo.Distance
Returns a Distance object with the specified value and DistanceUnit.METRES as the unit of measurement.
METRES - Static variable in class net.degreedays.geo.DistanceUnit
 
miles(double) - Static method in class net.degreedays.geo.Distance
Returns a Distance object with the specified value and DistanceUnit.MILES as the unit of measurement.
MILES - Static variable in class net.degreedays.geo.DistanceUnit
 
minusDays(int) - Method in class net.degreedays.time.Day
 
minusMonths(int) - Method in class net.degreedays.time.Day
 
minusWeeks(int) - Method in class net.degreedays.time.Day
 
minusYears(int) - Method in class net.degreedays.time.Day
 
minutesToReset() - Method in class net.degreedays.api.RateLimit
Returns the number of minutes until the rate limit is reset, at the time that this snapshot of the rate-limit state was taken.
MONDAY - Static variable in class net.degreedays.time.DayOfWeek
 
monthly(Period, StartOfMonth) - Static method in class net.degreedays.api.data.DatedBreakdown
Returns a non-null MonthlyBreakdown object that specifies monthly degree days covering the specified period in time, with each "month" starting on the specified day of the month.
monthly(Period) - Static method in class net.degreedays.api.data.DatedBreakdown
Returns a non-null MonthlyBreakdown object that specifies monthly degree days covering the specified period in time and broken down according to regular calendar months.
monthlyAverage(int) - Method in class net.degreedays.api.data.AverageDataSet
Returns the non-null average value for the specified month (e.g. pass 1 for the average value for the month of January).
MonthlyBreakdown - Class in net.degreedays.api.data.impl
A type of DatedBreakdown used to specify that degree days should be broken down on a monthly basis and cover a specific Period in time.
MonthlyBreakdown(Period, StartOfMonth) - Constructor for class net.degreedays.api.data.impl.MonthlyBreakdown
Constructs a MonthlyBreakdown object that specifies monthly degree days covering the specified period in time, with each "month" starting on the specified day of the month.
MonthlyBreakdown(Period) - Constructor for class net.degreedays.api.data.impl.MonthlyBreakdown
Constructs a MonthlyBreakdown object that specifies monthly degree days covering the specified period in time and broken down according to regular calendar months.
monthOfYear() - Method in class net.degreedays.time.Day
Returns a one-based number indicating the month-of-the-year component of this Day object.
monthOfYear() - Method in class net.degreedays.time.StartOfYear
Returns the number between 1 and 12 (inclusive) indicating the month of the calendar year in which the "year" defined by this StartOfYear starts.

N

net.degreedays.api - package net.degreedays.api
Core Degree Days.net API classes, including DegreeDaysApi - the starting point for all API operations.
net.degreedays.api.data - package net.degreedays.api.data
For specifying and receiving degree-day data from the API.
net.degreedays.api.data.impl - package net.degreedays.api.data.impl
Implementations of abstract types from net.degreedays.api.data.
net.degreedays.api.processing - package net.degreedays.api.processing
For advanced use, this enables customization of the request/response processing (XML, HTTP, security etc.).
net.degreedays.geo - package net.degreedays.geo
Provides some basic classes for handling geographic information like longitude/latitude positions and distances.
net.degreedays.time - package net.degreedays.time
A set of classes for working with dates and date-ranges in a time-zone independent context.
newRandom() - Method in interface net.degreedays.api.processing.RandomFactory
 
newTimestamp() - Method in interface net.degreedays.api.processing.TimestampFactory
 
next() - Method in class net.degreedays.time.Day
Returns the non-null Day that comes immediately after this Day in the calendar.
next() - Method in class net.degreedays.time.DayOfWeek
 
north(Distance) - Method in class net.degreedays.geo.LongLat
Returns a LongLat object that represents a position the specified distance North of this.
notEmpty() - Method in class net.degreedays.time.MaybeEmptyDayRanges
 
numberOfValues() - Method in class net.degreedays.api.data.impl.LatestValuesPeriod
Returns a number, greater than zero, indicating how many degree-day values this period should cover (see this explanation of how the values in question can be daily, weekly, monthly, or yearly).
numberOfYears() - Method in class net.degreedays.api.data.AverageDataSet
Returns the number of years of data that the average figures were calculated from (e.g. for 5-year-average data this would return 5).

O

of(double, double) - Static method in class net.degreedays.api.data.DataValue
Returns a non-null DataValue object with the specified configuration.
of(double, double, Day) - Static method in class net.degreedays.api.data.DatedDataValue
Returns a non-null DatedDataValue object with the specified value and percentage estimated, and covering just the specified Day.
of(double, double, DayRange) - Static method in class net.degreedays.api.data.DatedDataValue
Returns a non-null DatedDataValue object with the specified value and percentage estimated, and covering the specified DayRange.
of(int, int, int) - Static method in class net.degreedays.time.Day
Returns a non-null Day object representing a date with the specified year, month, and day.
of(int) - Static method in class net.degreedays.time.StartOfMonth
Returns a non-null StartOfMonth object specifying a definition of "months" that begin on the specified day of the month.
of(int, int) - Static method in class net.degreedays.time.StartOfYear
Returns a non-null StartOfYear object specifying a definition of "years" that begin on the specified first day of the year.

P

paramCount() - Method in class net.degreedays.api.processing.HttpRequest
 
parseResponse(InputStream, Request) - Method in interface net.degreedays.api.processing.ResponseParser
Note that it is not the responsibility of this parser to close the responseStream.
percentageEstimated() - Method in class net.degreedays.api.data.AverageDataSet
 
percentageEstimated() - Method in class net.degreedays.api.data.DataSet
Returns a number between 0 and 100 (both inclusive), indicating the overall extent to which this DataSet is based on estimated data.
percentageEstimated() - Method in class net.degreedays.api.data.DataValue
Returns a number between 0 and 100 (both inclusive), indicating the extent to which the calculated DataValue.value() is based on estimated data.
percentageEstimated() - Method in class net.degreedays.api.data.DatedDataSet
 
period() - Method in class net.degreedays.api.data.impl.DailyBreakdown
Returns the non-null period in time that the daily breakdown should cover.
period() - Method in class net.degreedays.api.data.impl.FullYearsAverageBreakdown
Returns the non-null period in time that the breakdown should average data from.
period() - Method in class net.degreedays.api.data.impl.MonthlyBreakdown
Returns the non-null period in time that the monthly breakdown should cover.
period() - Method in class net.degreedays.api.data.impl.WeeklyBreakdown
Returns the non-null period in time that the weekly breakdown should cover.
period() - Method in class net.degreedays.api.data.impl.YearlyBreakdown
Returns the non-null period in time that the yearly breakdown should cover.
Period - Class in net.degreedays.api.data
Defines the period in time that a set of degree days should cover.
plusDays(int) - Method in class net.degreedays.time.Day
 
plusMonths(int) - Method in class net.degreedays.time.Day
 
plusWeeks(int) - Method in class net.degreedays.time.Day
 
plusYears(int) - Method in class net.degreedays.time.Day
 
postalCode() - Method in class net.degreedays.api.data.impl.PostalCodeLocation
Returns the non-null, non-empty postal code (or zip code, post code, or postcode - the terminology depends on the country).
postalCode(String, String) - Static method in class net.degreedays.api.data.Location
Returns a non-null PostalCodeLocation object with a postal code (or zip code, post code, or postcode) and a two-letter country code representing the country that the postal code belongs to.
PostalCodeLocation - Class in net.degreedays.api.data.impl
Specifies a location using a postal code (or zip code, post code, or postcode - the terminology depends on the country).
PostalCodeLocation(String, String) - Constructor for class net.degreedays.api.data.impl.PostalCodeLocation
Constructs a PostalCodeLocation object with a postal code (or zip code, post code, or postcode) and a two-letter country code representing the country that the postal code belongs to.
previous() - Method in class net.degreedays.time.Day
Returns the non-null Day that comes immediately before this Day in the calendar.
previous() - Method in class net.degreedays.time.DayOfWeek
 
process(Request) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor
 
process(Request) - Method in interface net.degreedays.api.RequestProcessor
Processes the Request object and returns a Response object which is either a FailureResponse or a Response that's type is the counterpart to that of the Request object passed in.

R

random() - Method in class net.degreedays.api.processing.RequestSecurityInfo
 
RandomFactory - Interface in net.degreedays.api.processing
This generates the random strings that are used as part of the security mechanism that prevents replay attacks.
RateLimit - Class in net.degreedays.api
A snapshot of an API account's rate limit.
rateLimit() - Method in class net.degreedays.api.ResponseMetadata
Returns details of the rate limit that is currently associated with the account.
RateLimit.Builder - Class in net.degreedays.api
A builder class for creating immutable RateLimit objects e.g. for testing purposes.
RateLimit.Builder() - Constructor for class net.degreedays.api.RateLimit.Builder
 
RateLimitException - Exception in net.degreedays.api
Indicates that the API servers did not process a request because the RateLimit for the account's plan had been reached.
Request - Class in net.degreedays.api
Specifies an operation that you'd like the API to do (e.g. calculating a specific type of degree-day data for a specific location).
RequestFailureException - Exception in net.degreedays.api
Superclass of exceptions that indicate that the API's processing of a request resulted in a Failure.
RequestProcessor - Interface in net.degreedays.api
Processes API requests into API responses.
RequestSecurityInfo - Class in net.degreedays.api.processing
 
RequestSecurityInfo.Builder - Class in net.degreedays.api.processing
A builder class for creating immutable RequestSecurityInfo objects.
RequestSecurityInfo.Builder() - Constructor for class net.degreedays.api.processing.RequestSecurityInfo.Builder
 
RequestToXml - Interface in net.degreedays.api.processing
 
requestUnitsAvailable() - Method in class net.degreedays.api.RateLimit
Returns the number of request units available for use before the next reset, at the time that this snapshot of the rate-limit state was taken.
Response - Class in net.degreedays.api
Models the API's response to a Request (e.g. degree day data returned in response to a request for that data).
responseMetadata() - Method in exception net.degreedays.api.RequestFailureException
Returns the non-null metadata from the FailureResponse that brought details of this failure back from the API servers.
ResponseMetadata - Class in net.degreedays.api
Extra data that comes back with every response from the Degree Days.net API.
ResponseMetadata.Builder - Class in net.degreedays.api
A builder class for creating immutable ResponseMetadata objects e.g. for testing purposes.
ResponseMetadata.Builder() - Constructor for class net.degreedays.api.ResponseMetadata.Builder
 
ResponseParser - Interface in net.degreedays.api.processing
 

S

SATURDAY - Static variable in class net.degreedays.time.DayOfWeek
 
SecurityKey - Class in net.degreedays.api
The longer of the two access keys that are needed to use the Degree Days.net API.
SecurityKey(String) - Constructor for class net.degreedays.api.SecurityKey
Constructs a SecurityKey object using the specified string security key or throws an IllegalArgumentException if the string is clearly invalid.
SecurityKey(char[]) - Constructor for class net.degreedays.api.SecurityKey
Constructs a SecurityKey object using the specified characters, or throws an IllegalArgumentException if the characters are clearly invalid.
ServiceException - Exception in net.degreedays.api
Indicates that the API servers failed to process a request because of temporary downtime or an unexpected error (sorry!).
setAccountKey(AccountKey) - Method in class net.degreedays.api.processing.RequestSecurityInfo.Builder
 
setAnnualAverage(DataValue) - Method in class net.degreedays.api.data.AverageDataSet.Builder
 
setBytesToEncodedString(BytesToEncodedString) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setCode(String) - Method in class net.degreedays.api.Failure.Builder
 
setDataSets(DataSets) - Method in class net.degreedays.api.data.LocationDataResponse.Builder
 
setDateFormatter(DateFormatter) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setDisplayName(String) - Method in class net.degreedays.api.data.Station.Builder
 
setDistanceFromTarget(Distance) - Method in class net.degreedays.api.data.Source.Builder
 
setElevation(Distance) - Method in class net.degreedays.api.data.Station.Builder
 
setEndpoint(String) - Method in class net.degreedays.api.processing.RequestSecurityInfo.Builder
 
setEndpointGetter(EndpointGetter) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setFailure(Failure) - Method in class net.degreedays.api.FailureResponse.Builder
 
setFirstYear(int) - Method in class net.degreedays.api.data.AverageDataSet.Builder
 
setHttpRequestDispatcher(HttpRequestDispatcher) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setId(String) - Method in class net.degreedays.api.data.Station.Builder
 
setLastYear(int) - Method in class net.degreedays.api.data.AverageDataSet.Builder
 
setLongLat(LongLat) - Method in class net.degreedays.api.data.Station.Builder
 
setMessage(String) - Method in class net.degreedays.api.Failure.Builder
 
setMetadata(ResponseMetadata) - Method in class net.degreedays.api.data.LocationDataResponse.Builder
 
setMetadata(ResponseMetadata) - Method in class net.degreedays.api.data.LocationInfoResponse.Builder
 
setMetadata(ResponseMetadata) - Method in class net.degreedays.api.FailureResponse.Builder
 
setMinutesToReset(int) - Method in class net.degreedays.api.RateLimit.Builder
 
setMonthlyAverage(int, DataValue) - Method in class net.degreedays.api.data.AverageDataSet.Builder
Sets the average value for the specified month (January having index 1).
setPercentageEstimated(double) - Method in class net.degreedays.api.data.DatedDataSet.Builder
 
setRandom(String) - Method in class net.degreedays.api.processing.RequestSecurityInfo.Builder
 
setRandomFactory(RandomFactory) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setRateLimit(RateLimit) - Method in class net.degreedays.api.ResponseMetadata.Builder
 
setRequestToXml(RequestToXml) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setRequestUnitsAvailable(int) - Method in class net.degreedays.api.RateLimit.Builder
 
setResponseParser(ResponseParser) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setSigner(Signer) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setStation(Station) - Method in class net.degreedays.api.data.Source.Builder
 
setStationId(String) - Method in class net.degreedays.api.data.LocationDataResponse.Builder
 
setStationId(String) - Method in class net.degreedays.api.data.LocationInfoResponse.Builder
 
setStringToBytes(StringToBytes) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setTargetLongLat(LongLat) - Method in class net.degreedays.api.data.LocationDataResponse.Builder
 
setTargetLongLat(LongLat) - Method in class net.degreedays.api.data.LocationInfoResponse.Builder
 
setTimestamp(Date, DateFormatter) - Method in class net.degreedays.api.processing.RequestSecurityInfo.Builder
 
setTimestampFactory(TimestampFactory) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
setUrl(String) - Method in class net.degreedays.api.processing.HttpRequest.Builder
 
setXmlRequestWrapper(XmlRequestWrapper) - Method in class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
Signature - Class in net.degreedays.api.processing
 
Signature(byte[], String) - Constructor for class net.degreedays.api.processing.Signature
 
Signer - Interface in net.degreedays.api.processing
 
Source - Class in net.degreedays.api.data
Contains basic information about a source of data that was used to satisfy a request.
Source.Builder - Class in net.degreedays.api.data
A builder class for creating immutable Source objects e.g. for testing purposes.
Source.Builder() - Constructor for class net.degreedays.api.data.Source.Builder
 
SourceDataException - Exception in net.degreedays.api.data
Indicates a Failure to generate a DataSet caused by problems with the source temperature data for the Location and Period requested.
south(Distance) - Method in class net.degreedays.geo.LongLat
Returns a LongLat object that represents a position the specified distance South of this.
startOfMonth() - Method in class net.degreedays.api.data.impl.MonthlyBreakdown
Returns a non-null StartOfMonth object indicating which day should be taken as the first of each month (inclusive).
StartOfMonth - Class in net.degreedays.time
Specifies a definition of "months" that begin on a specified day of the month (e.g. 1 for calendar months).
StartOfMonth(int) - Constructor for class net.degreedays.time.StartOfMonth
Constructs a StartOfMonth object specifying a definition of "months" that begin on the specified day of the month.
startOfYear() - Method in class net.degreedays.api.data.impl.YearlyBreakdown
Returns a non-null StartOfYear object indicating which day should be taken as the first of each year (inclusive).
StartOfYear - Class in net.degreedays.time
Specifies a definition of "years" that begin on a specified day of the year (e.g. January 1st for calendar years).
StartOfYear(int, int) - Constructor for class net.degreedays.time.StartOfYear
Constructs a StartOfYear object specifying a definition of "years" that begin on the specified first day of the year.
station() - Method in class net.degreedays.api.data.Source
Returns the non-null Station that this source represents.
Station - Class in net.degreedays.api.data
Contains basic information about a weather station.
Station.Builder - Class in net.degreedays.api.data
A builder class for creating immutable Station objects e.g. for testing purposes.
Station.Builder() - Constructor for class net.degreedays.api.data.Station.Builder
 
stationId() - Method in class net.degreedays.api.data.impl.StationIdLocation
Returns the non-null, non-empty string ID of the weather station that this StationIdLocation represents.
stationId(String) - Static method in class net.degreedays.api.data.Location
Returns a non-null StationIdLocation object with the specified weather station ID.
stationId() - Method in class net.degreedays.api.data.LocationDataResponse
Returns the non-null, non-empty canonical ID of the weather station or combination of weather stations that supplied the temperature data used to calculate the returned degree days.
stationId() - Method in class net.degreedays.api.data.LocationInfoResponse
Returns the non-null, non-empty canonical ID of the weather station or combination of weather stations that would be used to generate data for an equivalent LocationDataResponse.
StationIdLocation - Class in net.degreedays.api.data.impl
Specifies a location in terms of a weather station ID (you can find these IDs through the website at www.degreedays.net or by requesting data from geographic locations).
StationIdLocation(String) - Constructor for class net.degreedays.api.data.impl.StationIdLocation
Constructs a StationIdLocation object with the specified weather station ID.
stream() - Method in class net.degreedays.api.processing.HttpResponseStream
Returns the non-null InputStream object that this HttpResponseStream object was created with.
StringToBytes - Interface in net.degreedays.api.processing
 
subRanges(int, int) - Method in class net.degreedays.time.MaybeEmptyDayRanges
 
SUNDAY - Static variable in class net.degreedays.time.DayOfWeek
 

T

targetLongLat() - Method in class net.degreedays.api.data.LocationDataResponse
Returns the non-null LongLat object that specifies the geographic position of the Location from the LocationDataRequest that led to this response.
targetLongLat() - Method in class net.degreedays.api.data.LocationInfoResponse
Returns the non-null LongLat object that specifies the geographic position of the Location from the LocationInfoRequest that led to this response.
Temperature - Class in net.degreedays.api.data
Defines a temperature value, typically the base temperature of a degree-day calculation.
Temperature(double, TemperatureUnit) - Constructor for class net.degreedays.api.data.Temperature
Constructs a Temperature object with the specified units and value (rounded to the nearest 0.1 degrees).
TemperatureUnit - Class in net.degreedays.api.data
Defines the units of temperature measurement with constants to represent Celsius and Fahrenheit.
THURSDAY - Static variable in class net.degreedays.time.DayOfWeek
 
timestamp() - Method in class net.degreedays.api.processing.RequestSecurityInfo
 
TimestampFactory - Interface in net.degreedays.api.processing
Creates a timestamp for inclusion in the request XML.
timestampString() - Method in class net.degreedays.api.processing.RequestSecurityInfo
 
to(Day) - Method in class net.degreedays.time.Day
Returns the non-null DayRange covering (inclusively) the days between this Day and firstOrLastDayInRange (which can be before, after, or equal to this Day).
toDailyDayRanges() - Method in class net.degreedays.time.DayRange
 
todayInSystemTimeZone() - Static method in class net.degreedays.time.Day
 
todayInUtc() - Static method in class net.degreedays.time.Day
 
toDayRanges(DayRange) - Method in class net.degreedays.api.data.DatedBreakdown
Returns the breakdown in terms of the day ranges that would constitute it given source data covering availableDataRange.
toDayRanges(DayRange) - Method in class net.degreedays.api.data.impl.DailyBreakdown
Returns the breakdown in terms of the day ranges that would constitute it given source data covering availableDataRange.
toDayRanges(DayRange) - Method in class net.degreedays.api.data.impl.MonthlyBreakdown
Returns the breakdown in terms of the day ranges that would constitute it given source data covering availableDataRange.
toDayRanges(DayRange) - Method in class net.degreedays.api.data.impl.WeeklyBreakdown
Returns the breakdown in terms of the day ranges that would constitute it given source data covering availableDataRange.
toDayRanges(DayRange) - Method in class net.degreedays.api.data.impl.YearlyBreakdown
Returns the breakdown in terms of the day ranges that would constitute it given source data covering availableDataRange.
toNumericString() - Method in class net.degreedays.api.data.Temperature
Returns a non-null, non-empty string representation of the numeric base-temperature value, like "50" or "15.5" or "-5" or "33.1", in a format suitable for insertion into the appropriate unit-specific element(s) of the request XML.
toNumericString() - Method in class net.degreedays.time.Day
Returns a non-null, non-empty string representation of this Day object in YYYYMMDD format.
toString() - Method in class net.degreedays.api.AccountKey
Returns the non-null, non-empty, canonical string account key.
toString() - Method in class net.degreedays.api.data.AverageDataSet
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.AverageDataSpec
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.DataSets
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.DataSpecs
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.DataValue
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.DatedDataSet
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.DatedDataSpec
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.DatedDataValue
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.CoolingDegreeDaysCalculation
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.DailyBreakdown
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.DayRangePeriod
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.FullYearsAverageBreakdown
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.HeatingDegreeDaysCalculation
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.LatestValuesPeriod
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.LongLatLocation
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.MonthlyBreakdown
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.PostalCodeLocation
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.StationIdLocation
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.WeeklyBreakdown
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.impl.YearlyBreakdown
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.LocationDataRequest
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.LocationDataResponse
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.LocationInfoRequest
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.LocationInfoResponse
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.Source
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.Station
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.data.Temperature
Returns a non-null, non-empty string representation of the temperature and its units.
toString() - Method in class net.degreedays.api.data.TemperatureUnit
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.Failure
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.FailureResponse
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.RateLimit
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.api.SecurityKey
Returns a non-null, non-empty string indicating that this is a SecurityKey object, but not giving any indication as to what the security key actually is.
toString() - Method in class net.degreedays.geo.Distance
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.geo.DistanceUnit
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.geo.LongLat
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.time.Day
Returns a non-null, non-empty string representation of this Day object in YYYY-MM-DD format.
toString() - Method in class net.degreedays.time.DayOfWeek
 
toString() - Method in class net.degreedays.time.DayRange
Returns a non-null, non-empty string representation of this object for logging and debugging purposes.
toString() - Method in class net.degreedays.time.StartOfMonth
Returns a non-null, non-empty string representation of this object in ---DD format, the format used by XML Schema's gDay type (based on ISO 8601).
toString() - Method in class net.degreedays.time.StartOfYear
Returns a non-null, non-empty string representation of this object in --MM-DD format, the format used by XML Schema's gMonthDay type (based on ISO 8601).
toStringKey() - Method in class net.degreedays.api.SecurityKey
Returns the non-null, non-empty, canonical string security key.
transformToAverage(AverageBreakdown) - Method in class net.degreedays.api.data.DatedDataSet
Returns a new AverageDataSet object, based on the data contained within this, but transformed to fit the targetBreakdown.
transformToDated(DatedBreakdown) - Method in class net.degreedays.api.data.DatedDataSet
Returns a new DatedDataSet object, based on the data contained within this, but transformed to fit the targetBreakdown.
TransportException - Exception in net.degreedays.api
Indicates an error transporting a request to the API servers or transporting a response back.
TransportException(String, Throwable) - Constructor for exception net.degreedays.api.TransportException
Constructs a new TransportException with the specified message and cause.
TransportException(String) - Constructor for exception net.degreedays.api.TransportException
Constructs a new TransportException with the specified message and null for the cause.
TransportException() - Constructor for exception net.degreedays.api.TransportException
Constructs a new TransportException with null for its message and cause.
TransportException(Throwable) - Constructor for exception net.degreedays.api.TransportException
Constructs a new TransportException with the specified cause and a detail message of cause.toString() or null if cause is null.
TUESDAY - Static variable in class net.degreedays.time.DayOfWeek
 

U

unit() - Method in class net.degreedays.api.data.Temperature
Returns the non-null unit of this temperature.
unit() - Method in class net.degreedays.geo.Distance
Returns the unit of measurement of this Distance object.
url() - Method in class net.degreedays.api.processing.HttpRequest
 

V

value() - Method in class net.degreedays.api.data.DataValue
Returns the value, which will never be NaN or infinity, and, for degree days, will always be zero or greater.
value() - Method in class net.degreedays.api.data.Temperature
Returns a double representation of the 0.1-precision number stored internally.
value() - Method in class net.degreedays.geo.Distance
Returns the numeric value of this Distance object.
valueAt(int) - Method in class net.degreedays.api.data.DatedDataSet
Returns the DatedDataValue at the specified index, which must be between 0 (inclusive) and DatedDataSet.valueCount() (exclusive).
valueCount() - Method in class net.degreedays.api.data.DatedDataSet
Returns the number of values held by this DatedDataSet object, which will always be greater than zero.
values() - Static method in class net.degreedays.api.data.TemperatureUnit
Returns an array of the available TemperatureUnit values.
values() - Static method in class net.degreedays.geo.DistanceUnit
Returns an array of the available DistanceUnit values.
values() - Static method in class net.degreedays.time.DayOfWeek
 

W

WEDNESDAY - Static variable in class net.degreedays.time.DayOfWeek
 
weekly(Period, DayOfWeek) - Static method in class net.degreedays.api.data.DatedBreakdown
Returns a non-null WeeklyBreakdown object that specifies weekly degree days covering the specified period in time, with each "week" starting on the specified day of the week.
WeeklyBreakdown - Class in net.degreedays.api.data.impl
A type of DatedBreakdown used to specify that degree days should be broken down on a weekly basis and cover a specific Period in time, with weeks starting on a specific day of the week.
WeeklyBreakdown(Period, DayOfWeek) - Constructor for class net.degreedays.api.data.impl.WeeklyBreakdown
Constructs a WeeklyBreakdown object that specifies weekly degree days covering the specified period in time, with each "week" starting on the specified day of the week.
west(Distance) - Method in class net.degreedays.geo.LongLat
Returns a LongLat object that represents a position the specified distance West of this.
withMinimumDayRange(DayRange) - Method in class net.degreedays.api.data.impl.DayRangePeriod
Returns a new DayRangePeriod with the same DayRangePeriod.dayRange() as this, but also specifying minimumDayRange as the minimum range required.
withMinimumNumberOfValues(int) - Method in class net.degreedays.api.data.impl.LatestValuesPeriod
Returns a new LatestValuesPeriod with the same LatestValuesPeriod.numberOfValues() as this, but also specifying minimumNumberOfValues as the minimum number of values required.

X

XmlHttpRequestProcessor - Class in net.degreedays.api.processing
A concrete implementation of the RequestProcessor interface that turns Request objects into XML, adds the necessary security details, sends them over HTTP to the Degree Days.net API servers, and parses the XML responses into Response object models.
XmlHttpRequestProcessor.Builder - Class in net.degreedays.api.processing
Builds XmlHttpRequestProcessor objects: create and configure a Builder object, then call XmlHttpRequestProcessor.Builder.build() to create an XmlHttpRequestProcessor object.
XmlHttpRequestProcessor.Builder(AccountKey, SecurityKey) - Constructor for class net.degreedays.api.processing.XmlHttpRequestProcessor.Builder
 
XmlRequestWrapper - Interface in net.degreedays.api.processing
 

Y

year() - Method in class net.degreedays.time.Day
Returns a number indicating the year component of this Day object.
yearly(Period, StartOfYear) - Static method in class net.degreedays.api.data.DatedBreakdown
Returns a non-null YearlyBreakdown object that specifies yearly degree days covering the specified period in time, with each "year" starting on the specified day of the year.
yearly(Period) - Static method in class net.degreedays.api.data.DatedBreakdown
Returns a non-null YearlyBreakdown object that specifies yearly degree days covering the specified period in time and broken down according to regular calendar years.
YearlyBreakdown - Class in net.degreedays.api.data.impl
A type of DatedBreakdown used to specify that degree days should be broken down on a yearly (annual) basis and cover a specific Period in time.
YearlyBreakdown(Period, StartOfYear) - Constructor for class net.degreedays.api.data.impl.YearlyBreakdown
Constructs a YearlyBreakdown object that specifies yearly degree days covering the specified period in time, with each "year" starting on the specified day of the year.
YearlyBreakdown(Period) - Constructor for class net.degreedays.api.data.impl.YearlyBreakdown
Constructs a YearlyBreakdown object that specifies yearly degree days covering the specified period in time and broken down according to regular calendar years.

A B C D E F G H I K L M N O P R S T U V W X Y

www.degreedays.net/api/