net.degreedays.api

Class ResponseMetadata

java.lang.Object

net.degreedays.api.ResponseMetadata

All Implemented Interfaces:

java.io.Serializable

public final class ResponseMetadata
extends java.lang.Object
implements java.io.Serializable

Extra data that comes back with every response from the Degree Days.net API.

The metadata for any particular response can be accessed via the metadata() method of the Response object, or via the responseMetadata() method of the RequestFailureException (if such an exception was thrown to indicate a failure in the server's processing of the API request).

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResponseMetadata.Builder A builder class for creating immutable ResponseMetadata objects e.g. for testing purposes.

Method Summary

Modifier and Type	Method and Description
RateLimit	rateLimit() Returns details of the rate limit that is currently associated with the API account.
java.lang.String	toString() Returns a non-null, non-empty string representation of this object for logging and debugging purposes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

rateLimit

public RateLimit rateLimit()

Returns details of the rate limit that is currently associated with the API account.

toString

public java.lang.String toString()

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

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

Overrides:

toString in class java.lang.Object