ForecastIO (ForecastIO-Lib-Java 1.5.1 API)

java.lang.Object
- com.github.dvdme.ForecastIOLib.ForecastIO

```
public class ForecastIO
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LANG_BOSNIAN`
`static String`	`LANG_DUTCH`
`static String`	`LANG_ENGLISH`
`static String`	`LANG_FRENCH`
`static String`	`LANG_GERMAN`
`static String`	`LANG_ITALIAN`
`static String`	`LANG_POLISH`
`static String`	`LANG_PORTUGUESE`
`static String`	`LANG_SPANISH`
`static String`	`LANG_TETUM`
`static String`	`LANG_X_PG_LATIN`
`static String`	`UNITS_AUTO`
`static String`	`UNITS_CA`
`static String`	`UNITS_SI`
`static String`	`UNITS_UK`
`static String`	`UNITS_US`

Constructor Summary

Constructors
Constructor and Description
`ForecastIO(String API_KEY)`
`ForecastIO(String LATITUDE, String LONGITUDE, String API_KEY)`
`ForecastIO(String LATITUDE, String LONGITUDE, String UNITS, String LANG, String API_KEY)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.eclipsesource.json.JsonArray`	`getAlerts()` Returns the alerts data
`com.eclipsesource.json.JsonObject`	`getCurrently()` Returns the currently data point
`com.eclipsesource.json.JsonObject`	`getDaily()` Returns the daily data block
`String`	`getExcludeURL()` Returns the excluded fields that are setted for the request.
`com.eclipsesource.json.JsonObject`	`getFlags()` Returns the flags data
`boolean`	`getForecast(com.eclipsesource.json.JsonObject forecast)` Parses the forecast reports for the given coordinates with the setted options Useful to use with an external http library Hint: The getForecast(String http_response) could be more useful since it receives the raw response String instead of the JsonObect.
`boolean`	`getForecast(String http_response)` Parses the forecast reports for the given coordinates with the set options Useful to use with an external http library
`boolean`	`getForecast(String LATITUDE, String LONGITUDE)` Gets the forecast reports for the given coordinates with the set options
`String`	`getHeaderCache_Control()` Returns the Cache-Control response header value
`String`	`getHeaderExpires()` Returns the Expires response header value
`String`	`getHeaderX_Forecast_API_Calls()` Returns the X-Forecast-API-Calls response header value This is the number os API calls made today from one given API Key.
`String`	`getHeaderX_Response_Time()` Returns the X-Response-Time response header value
`com.eclipsesource.json.JsonObject`	`getHourly()` Returns the hourly data block
`String`	`getLang()` Returns the language that are set in the request.
`Double`	`getLatitude()` Returns the latitude that is setted for the request.
`Double`	`getLongitude()` Returns the longitude that is setted for the request.
`com.eclipsesource.json.JsonObject`	`getMinutely()` Returns the minutely data block
`String`	`getRawResponse()` Returns the raw JSON response
`String`	`getTime()` Returns the time that is setted for the request.
`String`	`getTimezone()` Returns the timezone that is setted.
`String`	`getUnits()` Returns the units that are set in the request.
`String`	`getUrl(String LATITUDE, String LONGITUDE)` Returns the url that is created by internal UrlBuilder method.
`boolean`	`hasAlerts()` Checks if there is any flags data available
`boolean`	`hasCurrently()` Checks if there is any currently data available
`boolean`	`hasDaily()` Checks if there is any daily data available
`boolean`	`hasFlags()` Checks if there is any flags data available
`boolean`	`hasHourly()` Checks if there is any hourly data available
`boolean`	`hasMinutely()` Checks if there is any minutely data available
`boolean`	`isExtend()` Returns if the hourly report should be extended in the request.
`String`	`offset()` Returns the offset as a String with '+' or '-' sign.
`int`	`offsetValue()` Returns the timezone offset in an integer For more information refer to the API Docs: https://developer.forecast.io
`void`	`setExcludeURL(String excludeURL)` Sets the fields to be excluded in the request. Format should be as follows: [field1,field2,fieldN] with no spaces For more information refer to the API Docs: https://developer.forecast.io
`void`	`setExtend(boolean extend)` Sets if the hourly report should be extended in the request.
`void`	`setLang(String lang)` Sets the language to be passed in the request.
`void`	`setTime(String time)` Sets the time for the request.
`void`	`setUnits(String units)` Sets the units to be passed in the request.
`boolean`	`update()` Does another query to the API and updates the data This only updates the data in ForecastIO class

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNITS_US
```
public static final String UNITS_US
```
    See Also:
    
    Constant Field Values
  - UNITS_SI
```
public static final String UNITS_SI
```
    See Also:
    
    Constant Field Values
  - UNITS_CA
```
public static final String UNITS_CA
```
    See Also:
    
    Constant Field Values
  - UNITS_UK
```
public static final String UNITS_UK
```
    See Also:
    
    Constant Field Values
  - UNITS_AUTO
```
public static final String UNITS_AUTO
```
    See Also:
    
    Constant Field Values
  - LANG_BOSNIAN
```
public static final String LANG_BOSNIAN
```
    See Also:
    
    Constant Field Values
  - LANG_GERMAN
```
public static final String LANG_GERMAN
```
    See Also:
    
    Constant Field Values
  - LANG_ENGLISH
```
public static final String LANG_ENGLISH
```
    See Also:
    
    Constant Field Values
  - LANG_SPANISH
```
public static final String LANG_SPANISH
```
    See Also:
    
    Constant Field Values
  - LANG_FRENCH
```
public static final String LANG_FRENCH
```
    See Also:
    
    Constant Field Values
  - LANG_ITALIAN
```
public static final String LANG_ITALIAN
```
    See Also:
    
    Constant Field Values
  - LANG_DUTCH
```
public static final String LANG_DUTCH
```
    See Also:
    
    Constant Field Values
  - LANG_POLISH
```
public static final String LANG_POLISH
```
    See Also:
    
    Constant Field Values
  - LANG_PORTUGUESE
```
public static final String LANG_PORTUGUESE
```
    See Also:
    
    Constant Field Values
  - LANG_TETUM
```
public static final String LANG_TETUM
```
    See Also:
    
    Constant Field Values
  - LANG_X_PG_LATIN
```
public static final String LANG_X_PG_LATIN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ForecastIO
```
public ForecastIO(String API_KEY)
```
  - ForecastIO
```
public ForecastIO(String LATITUDE,
                  String LONGITUDE,
                  String API_KEY)
```
  - ForecastIO
```
public ForecastIO(String LATITUDE,
                  String LONGITUDE,
                  String UNITS,
                  String LANG,
                  String API_KEY)
```
- Method Detail
  - getLatitude
```
public Double getLatitude()
```
    Returns the latitude that is setted for the request.
    
    Returns:
    
    A Double number with the latitude.
  - getLongitude
```
public Double getLongitude()
```
    Returns the longitude that is setted for the request.
    
    Returns:
    
    A Double number with the longitude.
  - getTimezone
```
public String getTimezone()
```
    Returns the timezone that is setted.
    
    Returns:
    
    A String with the timezone.
  - getTime
```
public String getTime()
```
    Returns the time that is setted for the request.
    
    Returns:
    
    A String with the time
  - setTime
```
public void setTime(String time)
```
    Sets the time for the request. Format should be passed as follows:
    [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS]{+,-}[HH][MM]
    The last {+,-}[HH][MM] is the timezone
    Example:
    [2013-05-06T12:00:00-0400]
    For more information refer to the API Docs: https://developer.forecast.io
    
    Parameters:
    
    time - in the described format
  - getExcludeURL
```
public String getExcludeURL()
```
    Returns the excluded fields that are setted for the request.
    
    Returns:
    
    A String with the fields excluded
  - setExcludeURL
```
public void setExcludeURL(String excludeURL)
```
    Sets the fields to be excluded in the request.
    Format should be as follows:
    [field1,field2,fieldN] with no spaces For more information refer to the API Docs: https://developer.forecast.io
    
    Parameters:
    
    excludeURL - in the described format
  - isExtend
```
public boolean isExtend()
```
    Returns if the hourly report should be extended in the request.
    
    Returns:
    
    true or false
  - setExtend
```
public void setExtend(boolean extend)
```
    Sets if the hourly report should be extended in the request. For more information refer to the API Docs: https://developer.forecast.io
    
    Parameters:
    
    extend - true or false to extend or not the request
  - offsetValue
```
public int offsetValue()
```
    Returns the timezone offset in an integer For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    integer with the offset
  - offset
```
public String offset()
```
    Returns the offset as a String with '+' or '-' sign. For more information refer to the API Docs: https://developer.forecast.io
    
    Returns:
    
    String with the offset
  - getUnits
```
public String getUnits()
```
    Returns the units that are set in the request.
    
    Returns:
    
    String with the units set
  - setUnits
```
public void setUnits(String units)
```
    Sets the units to be passed in the request. If the units are unavailable, auto is set.
    Units can be set with constants like ForecastIO.UNITS_AUTO. For more information refer to the API Docs: https://developer.forecast.io
    
    Parameters:
    
    units - the units to be set. Units can set with a constant like ForecastIO.UNITS_SI. (If the units are invalid the API will return an error)
  - getLang
```
public String getLang()
```
    Returns the language that are set in the request.
    
    Returns:
    
    String with the language set
  - setLang
```
public void setLang(String lang)
```
    Sets the language to be passed in the request. If the language is not unavailable, english is set.
    Units can be set with constants like ForecastIO.LANG_ENGLISH. For more information refer to the API Docs: https://developer.forecast.io
    
    Parameters:
    
    lang - the language to set. this can be set with the constant ForecastIO.LANG_ENGLISH (example for english). If a constant is not available for a given an available API language it can be set with the language code. (If the language is invalid the API will return an error)
  - getCurrently
```
public com.eclipsesource.json.JsonObject getCurrently()
```
    Returns the currently data point
    
    Returns:
    
    JsonObject with the data point
  - getMinutely
```
public com.eclipsesource.json.JsonObject getMinutely()
```
    Returns the minutely data block
    
    Returns:
    
    JsonObject with the data block
  - getHourly
```
public com.eclipsesource.json.JsonObject getHourly()
```
    Returns the hourly data block
    
    Returns:
    
    JsonObject with the data block
  - getFlags
```
public com.eclipsesource.json.JsonObject getFlags()
```
    Returns the flags data
    
    Returns:
    
    JsonObject with the data
  - getAlerts
```
public com.eclipsesource.json.JsonArray getAlerts()
```
    Returns the alerts data
    
    Returns:
    
    JsonObject with the data
  - getDaily
```
public com.eclipsesource.json.JsonObject getDaily()
```
    Returns the daily data block
    
    Returns:
    
    JsonObject with the data block
  - hasCurrently
```
public boolean hasCurrently()
```
    Checks if there is any currently data available
    
    Returns:
    
    true or false
  - hasMinutely
```
public boolean hasMinutely()
```
    Checks if there is any minutely data available
    
    Returns:
    
    true or false
  - hasHourly
```
public boolean hasHourly()
```
    Checks if there is any hourly data available
    
    Returns:
    
    true or false
  - hasDaily
```
public boolean hasDaily()
```
    Checks if there is any daily data available
    
    Returns:
    
    true or false
  - hasFlags
```
public boolean hasFlags()
```
    Checks if there is any flags data available
    
    Returns:
    
    true or false
  - hasAlerts
```
public boolean hasAlerts()
```
    Checks if there is any flags data available
    
    Returns:
    
    true or false
  - update
```
public boolean update()
```
    Does another query to the API and updates the data This only updates the data in ForecastIO class
    
    Returns:
    
    True if successful
  - getForecast
```
public boolean getForecast(String LATITUDE,
                           String LONGITUDE)
```
    Gets the forecast reports for the given coordinates with the set options
    
    Parameters:
    
    LATITUDE - the geographical latitude
    
    LONGITUDE - the geographical longitude
    
    Returns:
    
    True if successful
  - getForecast
```
public boolean getForecast(String http_response)
```
    Parses the forecast reports for the given coordinates with the set options Useful to use with an external http library
    
    Parameters:
    
    http_response - String
    
    Returns:
    
    boolean
  - getForecast
```
public boolean getForecast(com.eclipsesource.json.JsonObject forecast)
```
    Parses the forecast reports for the given coordinates with the setted options Useful to use with an external http library Hint: The getForecast(String http_response) could be more useful since it receives the raw response String instead of the JsonObect.
    
    Parameters:
    
    forecast - JsonObject
    
    Returns:
    
    true if successful
  - getUrl
```
public String getUrl(String LATITUDE,
                     String LONGITUDE)
```
    Returns the url that is created by internal UrlBuilder method. Useful to use with an external http library
    
    Parameters:
    
    LATITUDE - the geographical latitude
    
    LONGITUDE - the geographical longitude
    
    Returns:
    
    url string.
  - getHeaderCache_Control
```
public String getHeaderCache_Control()
```
    Returns the Cache-Control response header value
    
    Returns:
    
    the string with the header value
  - getHeaderExpires
```
public String getHeaderExpires()
```
    Returns the Expires response header value
    
    Returns:
    
    the string with the header value
  - getHeaderX_Forecast_API_Calls
```
public String getHeaderX_Forecast_API_Calls()
```
    Returns the X-Forecast-API-Calls response header value
    This is the number os API calls made today from one given API Key.
    
    Returns:
    
    the string with the header value
  - getHeaderX_Response_Time
```
public String getHeaderX_Response_Time()
```
    Returns the X-Response-Time response header value
    
    Returns:
    
    the string with the header value
  - getRawResponse
```
public String getRawResponse()
```
    Returns the raw JSON response
    
    Returns:
    
    the string with the JSON response

Class ForecastIO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNITS_US

UNITS_SI

UNITS_CA

UNITS_UK

UNITS_AUTO

LANG_BOSNIAN

LANG_GERMAN

LANG_ENGLISH

LANG_SPANISH

LANG_FRENCH

LANG_ITALIAN

LANG_DUTCH

LANG_POLISH

LANG_PORTUGUESE

LANG_TETUM

LANG_X_PG_LATIN

Constructor Detail

ForecastIO

ForecastIO

ForecastIO

Method Detail

getLatitude

getLongitude

getTimezone

getTime

setTime

getExcludeURL

setExcludeURL

isExtend

setExtend

offsetValue

offset

getUnits

setUnits

getLang

setLang

getCurrently

getMinutely

getHourly

getFlags

getAlerts

getDaily

hasCurrently

hasMinutely

hasHourly

hasDaily

hasFlags

hasAlerts

update

getForecast

getForecast

getForecast

getUrl

getHeaderCache_Control

getHeaderExpires

getHeaderX_Forecast_API_Calls

getHeaderX_Response_Time

getRawResponse