ImmutableFioResponse (Forecast.io client library 1.0.0 API)

java.lang.Object
- ch.rasc.forcastio.model.ImmutableFioResponse

All Implemented Interfaces:

FioResponse
```
@Generated(value={"Immutables.generator","FioResponse"})
public final class ImmutableFioResponse
extends Object
implements FioResponse
```
Immutable implementation of FioResponse.
Use the builder to create immutable instances: ImmutableFioResponse.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableFioResponse.Builder
Builds instances of type ImmutableFioResponse.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableFioResponse.Builder` Builds instances of type `ImmutableFioResponse`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<FioAlert>`	`alerts()` A collection of `FioAlert` instances, which, if present, contains any severe weather alerts, issued by a governmental weather authority, pertinent to the requested location.
`static ImmutableFioResponse.Builder`	`builder()` Creates a builder for `ImmutableFioResponse`.
`static ImmutableFioResponse`	`copyOf(FioResponse instance)` Creates an immutable copy of a `FioResponse` value.
`FioDataPoint`	`currently()` An instance of `FioDataPoint` containing the current weather conditions at the requested location.
`FioDataBlock`	`daily()` An instance of `FioDataPoint` containing the weather conditions day-by-day for the next week.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableFioResponse` that have equal attribute values.
`FioFlag`	`flags()` An instance of `FioFlag` containing miscellaneous metadata concerning this request.
`int`	`hashCode()` Computes a hash code from attributes: `latitude`, `longitude`, `timezone`, `offset`, `currently`, `minutely`, `hourly`, `daily`, `alerts`, `flags`.
`FioDataBlock`	`hourly()` An instance of `FioDataPoint` containing the weather conditions hour-by-hour for the next two days.
`BigDecimal`	`latitude()` The requested latitude.
`BigDecimal`	`longitude()` The requested longitude.
`FioDataBlock`	`minutely()` An instance of `FioDataPoint` containing the weather conditions minute-by-minute for the next hour.
`int`	`offset()` The current timezone offset in hours from GMT.
`String`	`timezone()` The IANA timezone name for the requested location (e.g.
`String`	`toString()` Prints the immutable value `FioResponse` with attribute values.
`ImmutableFioResponse`	`withAlerts(FioAlert... elements)` Copy the current immutable object with elements that replace the content of `alerts`.
`ImmutableFioResponse`	`withAlerts(Iterable<? extends FioAlert> elements)` Copy the current immutable object with elements that replace the content of `alerts`.
`ImmutableFioResponse`	`withCurrently(FioDataPoint currently)` Copy the current immutable object by setting a value for the `currently` attribute.
`ImmutableFioResponse`	`withDaily(FioDataBlock daily)` Copy the current immutable object by setting a value for the `daily` attribute.
`ImmutableFioResponse`	`withFlags(FioFlag flags)` Copy the current immutable object by setting a value for the `flags` attribute.
`ImmutableFioResponse`	`withHourly(FioDataBlock hourly)` Copy the current immutable object by setting a value for the `hourly` attribute.
`ImmutableFioResponse`	`withLatitude(BigDecimal latitude)` Copy the current immutable object by setting a value for the `latitude` attribute.
`ImmutableFioResponse`	`withLongitude(BigDecimal longitude)` Copy the current immutable object by setting a value for the `longitude` attribute.
`ImmutableFioResponse`	`withMinutely(FioDataBlock minutely)` Copy the current immutable object by setting a value for the `minutely` attribute.
`ImmutableFioResponse`	`withOffset(int offset)` Copy the current immutable object by setting a value for the `offset` attribute.
`ImmutableFioResponse`	`withTimezone(String timezone)` Copy the current immutable object by setting a value for the `timezone` attribute.

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

- Method Detail
  - latitude
```
public BigDecimal latitude()
```
    The requested latitude.
    
    Specified by:
    
    latitude in interface FioResponse
  - longitude
```
public BigDecimal longitude()
```
    The requested longitude.
    
    Specified by:
    
    longitude in interface FioResponse
  - timezone
```
public String timezone()
```
    The IANA timezone name for the requested location (e.g. America/New_York). This is the timezone used for text forecast summaries and for determining the exact start time of daily data points. (Developers are advised to rely on local system settings rather than this value if at all possible: users may deliberately set an unusual timezone, and furthermore are likely to know what they actually want better than our timezone database does.)
    
    Specified by:
    
    timezone in interface FioResponse
  - offset
```
public int offset()
```
    The current timezone offset in hours from GMT. (This value is deprecated and should not be used.)
    
    Specified by:
    
    offset in interface FioResponse
  - currently
```
public FioDataPoint currently()
```
    An instance of FioDataPoint containing the current weather conditions at the requested location.
    
    Specified by:
    
    currently in interface FioResponse
  - minutely
```
public FioDataBlock minutely()
```
    An instance of FioDataPoint containing the weather conditions minute-by-minute for the next hour.
    
    Specified by:
    
    minutely in interface FioResponse
  - hourly
```
public FioDataBlock hourly()
```
    An instance of FioDataPoint containing the weather conditions hour-by-hour for the next two days.
    
    Specified by:
    
    hourly in interface FioResponse
  - daily
```
public FioDataBlock daily()
```
    An instance of FioDataPoint containing the weather conditions day-by-day for the next week.
    
    Specified by:
    
    daily in interface FioResponse
  - alerts
```
public List<FioAlert> alerts()
```
    A collection of FioAlert instances, which, if present, contains any severe weather alerts, issued by a governmental weather authority, pertinent to the requested location.
    
    Specified by:
    
    alerts in interface FioResponse
  - flags
```
public FioFlag flags()
```
    An instance of FioFlag containing miscellaneous metadata concerning this request.
    
    Specified by:
    
    flags in interface FioResponse
  - withLatitude
```
public final ImmutableFioResponse withLatitude(BigDecimal latitude)
```
    Copy the current immutable object by setting a value for the latitude attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    latitude - A new value for latitude
    
    Returns:
    
    A modified copy of the this object
  - withLongitude
```
public final ImmutableFioResponse withLongitude(BigDecimal longitude)
```
    Copy the current immutable object by setting a value for the longitude attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    longitude - A new value for longitude
    
    Returns:
    
    A modified copy of the this object
  - withTimezone
```
public final ImmutableFioResponse withTimezone(String timezone)
```
    Copy the current immutable object by setting a value for the timezone attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    timezone - A new value for timezone
    
    Returns:
    
    A modified copy of the this object
  - withOffset
```
public final ImmutableFioResponse withOffset(int offset)
```
    Copy the current immutable object by setting a value for the offset attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    offset - A new value for offset
    
    Returns:
    
    A modified copy of the this object
  - withCurrently
```
public final ImmutableFioResponse withCurrently(FioDataPoint currently)
```
    Copy the current immutable object by setting a value for the currently attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    currently - A new value for currently (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withMinutely
```
public final ImmutableFioResponse withMinutely(FioDataBlock minutely)
```
    Copy the current immutable object by setting a value for the minutely attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    minutely - A new value for minutely (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withHourly
```
public final ImmutableFioResponse withHourly(FioDataBlock hourly)
```
    Copy the current immutable object by setting a value for the hourly attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    hourly - A new value for hourly (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withDaily
```
public final ImmutableFioResponse withDaily(FioDataBlock daily)
```
    Copy the current immutable object by setting a value for the daily attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    daily - A new value for daily (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withAlerts
```
public final ImmutableFioResponse withAlerts(FioAlert... elements)
```
    Copy the current immutable object with elements that replace the content of alerts.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withAlerts
```
public final ImmutableFioResponse withAlerts(Iterable<? extends FioAlert> elements)
```
    Copy the current immutable object with elements that replace the content of alerts. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of alerts elements to set
    
    Returns:
    
    A modified copy of this object
  - withFlags
```
public final ImmutableFioResponse withFlags(FioFlag flags)
```
    Copy the current immutable object by setting a value for the flags attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    flags - A new value for flags
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableFioResponse that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: latitude, longitude, timezone, offset, currently, minutely, hourly, daily, alerts, flags.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value FioResponse with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableFioResponse copyOf(FioResponse instance)
```
    Creates an immutable copy of a FioResponse value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable FioResponse instance
  - builder
```
public static ImmutableFioResponse.Builder builder()
```
    Creates a builder for ImmutableFioResponse.
    
    Returns:
    
    A new ImmutableFioResponse builder

Class ImmutableFioResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

latitude

longitude

timezone

offset

currently

minutely

hourly

daily

alerts

flags

withLatitude

withLongitude

withTimezone

withOffset

withCurrently

withMinutely

withHourly

withDaily

withAlerts

withAlerts

withFlags

equals

hashCode

toString

copyOf

builder