ImmutableDsResponse (Dark Sky API client library 2.0.1 API)

java.lang.Object
- ch.rasc.darksky.model.ImmutableDsResponse

All Implemented Interfaces:: DsResponse

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
public final class ImmutableDsResponse
extends Object
implements DsResponse

Immutable implementation of DsResponse.

Use the builder to create immutable instances: ImmutableDsResponse.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableDsResponse.Builder
Builds instances of type ImmutableDsResponse.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`List<DsAlert>`	`alerts()` A list of `DsAlert` instances, which, if present, contains any severe weather alerts pertinent to the requested location.
`static ImmutableDsResponse.Builder`	`builder()` Creates a builder for `ImmutableDsResponse`.
`static ImmutableDsResponse`	`copyOf(DsResponse instance)` Creates an immutable copy of a `DsResponse` value.
`DsDataPoint`	`currently()` A `DsDataPoint` containing the current weather conditions at the requested location.
`DsDataBlock`	`daily()` A `DsDataBlock` containing the weather conditions day-by-day for the next week.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableDsResponse` that have equal attribute values.
`DsFlag`	`flags()` A `DsFlag` object containing miscellaneous metadata about the request.
`int`	`hashCode()` Computes a hash code from attributes: `latitude`, `longitude`, `timezone`, `offset`, `currently`, `minutely`, `hourly`, `daily`, `alerts`, `flags`.
`DsDataBlock`	`hourly()` A `DsDataBlock` containing the weather conditions hour-by-hour for the next two days.
`BigDecimal`	`latitude()` The requested latitude.
`BigDecimal`	`longitude()` The requested longitude.
`DsDataBlock`	`minutely()` A `DsDataBlock` containing the weather conditions minute-by-minute for the next hour.
`int`	`offset()` Deprecated.
`String`	`timezone()` The IANA timezone name for the requested location.
`String`	`toString()` Prints the immutable value `DsResponse` with attribute values.
`ImmutableDsResponse`	`withAlerts(DsAlert... elements)` Copy the current immutable object with elements that replace the content of `alerts`.
`ImmutableDsResponse`	`withAlerts(Iterable<? extends DsAlert> elements)` Copy the current immutable object with elements that replace the content of `alerts`.
`ImmutableDsResponse`	`withCurrently(DsDataPoint value)` Copy the current immutable object by setting a value for the `currently` attribute.
`ImmutableDsResponse`	`withDaily(DsDataBlock value)` Copy the current immutable object by setting a value for the `daily` attribute.
`ImmutableDsResponse`	`withFlags(DsFlag value)` Copy the current immutable object by setting a value for the `flags` attribute.
`ImmutableDsResponse`	`withHourly(DsDataBlock value)` Copy the current immutable object by setting a value for the `hourly` attribute.
`ImmutableDsResponse`	`withLatitude(BigDecimal value)` Copy the current immutable object by setting a value for the `latitude` attribute.
`ImmutableDsResponse`	`withLongitude(BigDecimal value)` Copy the current immutable object by setting a value for the `longitude` attribute.
`ImmutableDsResponse`	`withMinutely(DsDataBlock value)` Copy the current immutable object by setting a value for the `minutely` attribute.
`ImmutableDsResponse`	`withOffset(int value)` Deprecated.
`ImmutableDsResponse`	`withTimezone(String value)` 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 DsResponse
  - longitude
```
public BigDecimal longitude()
```
    The requested longitude.
    
    Specified by:
    
    longitude in interface DsResponse
  - timezone
```
public String timezone()
```
    The IANA timezone name for the requested location. This is used for text DsDataPoint.summary() and for determining when hourly() and daily() data block objects begin.
    
    Specified by:
    
    timezone in interface DsResponse
  - offset
```
@Deprecated
public int offset()
```
    Deprecated.
    
    The current timezone offset in hours. (Use of this property will almost certainly result in Daylight Saving Time bugs. Please use timezone, instead.)
    
    Specified by:
    
    offset in interface DsResponse
  - currently
```
@Nullable
public DsDataPoint currently()
```
    A DsDataPoint containing the current weather conditions at the requested location.
    
    Specified by:
    
    currently in interface DsResponse
  - minutely
```
@Nullable
public DsDataBlock minutely()
```
    A DsDataBlock containing the weather conditions minute-by-minute for the next hour.
    
    Specified by:
    
    minutely in interface DsResponse
  - hourly
```
@Nullable
public DsDataBlock hourly()
```
    A DsDataBlock containing the weather conditions hour-by-hour for the next two days.
    
    Specified by:
    
    hourly in interface DsResponse
  - daily
```
@Nullable
public DsDataBlock daily()
```
    A DsDataBlock containing the weather conditions day-by-day for the next week.
    
    Specified by:
    
    daily in interface DsResponse
  - alerts
```
public List<DsAlert> alerts()
```
    A list of DsAlert instances, which, if present, contains any severe weather alerts pertinent to the requested location.
    
    Specified by:
    
    alerts in interface DsResponse
  - flags
```
@Nullable
public DsFlag flags()
```
    A DsFlag object containing miscellaneous metadata about the request.
    
    Specified by:
    
    flags in interface DsResponse
  - withLatitude
```
public final ImmutableDsResponse withLatitude(BigDecimal value)
```
    Copy the current immutable object by setting a value for the latitude attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for latitude
    
    Returns:
    
    A modified copy of the this object
  - withLongitude
```
public final ImmutableDsResponse withLongitude(BigDecimal value)
```
    Copy the current immutable object by setting a value for the longitude attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for longitude
    
    Returns:
    
    A modified copy of the this object
  - withTimezone
```
public final ImmutableDsResponse withTimezone(String value)
```
    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:
    
    value - A new value for timezone
    
    Returns:
    
    A modified copy of the this object
  - withOffset
```
@Deprecated
public final ImmutableDsResponse withOffset(int value)
```
    Deprecated.
    
    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:
    
    value - A new value for offset
    
    Returns:
    
    A modified copy of the this object
  - withCurrently
```
public final ImmutableDsResponse withCurrently(@Nullable
                                               DsDataPoint value)
```
    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:
    
    value - A new value for currently (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withMinutely
```
public final ImmutableDsResponse withMinutely(@Nullable
                                              DsDataBlock value)
```
    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:
    
    value - A new value for minutely (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withHourly
```
public final ImmutableDsResponse withHourly(@Nullable
                                            DsDataBlock value)
```
    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:
    
    value - A new value for hourly (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withDaily
```
public final ImmutableDsResponse withDaily(@Nullable
                                           DsDataBlock value)
```
    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:
    
    value - A new value for daily (can be null)
    
    Returns:
    
    A modified copy of the this object
  - withAlerts
```
public final ImmutableDsResponse withAlerts(DsAlert... 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 ImmutableDsResponse withAlerts(Iterable<? extends DsAlert> 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 ImmutableDsResponse withFlags(@Nullable
                                           DsFlag value)
```
    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:
    
    value - A new value for flags (can be null)
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableDsResponse 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 DsResponse with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableDsResponse copyOf(DsResponse instance)
```
    Creates an immutable copy of a DsResponse 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 DsResponse instance
  - builder
```
public static ImmutableDsResponse.Builder builder()
```
    Creates a builder for ImmutableDsResponse.
```
 ImmutableDsResponse.builder()
    .latitude(java.math.BigDecimal) // required latitude
    .longitude(java.math.BigDecimal) // required longitude
    .timezone(String) // required timezone
    .offset(int) // required offset
    .currently(ch.rasc.darksky.model.DsDataPoint | null) // nullable currently
    .minutely(ch.rasc.darksky.model.DsDataBlock | null) // nullable minutely
    .hourly(ch.rasc.darksky.model.DsDataBlock | null) // nullable hourly
    .daily(ch.rasc.darksky.model.DsDataBlock | null) // nullable daily
    .addAlerts|addAllAlerts(ch.rasc.darksky.model.DsAlert) // alerts elements
    .flags(ch.rasc.darksky.model.DsFlag | null) // nullable flags
    .build();
 
```
    Returns:
    
    A new ImmutableDsResponse builder

Class ImmutableDsResponse

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