ch.rasc.darksky.model

Class ImmutableDsResponse.Builder

java.lang.Object

ch.rasc.darksky.model.ImmutableDsResponse.Builder

Enclosing class:

ImmutableDsResponse

@NotThreadSafe
public static final class ImmutableDsResponse.Builder
extends Object

Builds instances of type ImmutableDsResponse. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
ImmutableDsResponse.Builder	addAlerts(DsAlert... elements) Adds elements to alerts list.
ImmutableDsResponse.Builder	addAlerts(DsAlert element) Adds one element to alerts list.
ImmutableDsResponse.Builder	addAllAlerts(Iterable<? extends DsAlert> elements) Adds elements to alerts list.
ImmutableDsResponse.Builder	alerts(Iterable<? extends DsAlert> elements) Sets or replaces all elements for alerts list.
ImmutableDsResponse	build() Builds a new ImmutableDsResponse.
ImmutableDsResponse.Builder	currently(DsDataPoint currently) Initializes the value for the currently attribute.
ImmutableDsResponse.Builder	daily(DsDataBlock daily) Initializes the value for the daily attribute.
ImmutableDsResponse.Builder	flags(DsFlag flags) Initializes the value for the flags attribute.
ImmutableDsResponse.Builder	from(DsResponse instance) Fill a builder with attribute values from the provided DsResponse instance.
ImmutableDsResponse.Builder	hourly(DsDataBlock hourly) Initializes the value for the hourly attribute.
ImmutableDsResponse.Builder	latitude(BigDecimal latitude) Initializes the value for the latitude attribute.
ImmutableDsResponse.Builder	longitude(BigDecimal longitude) Initializes the value for the longitude attribute.
ImmutableDsResponse.Builder	minutely(DsDataBlock minutely) Initializes the value for the minutely attribute.
ImmutableDsResponse.Builder	offset(int offset) Deprecated.
ImmutableDsResponse.Builder	timezone(String timezone) Initializes the value for the timezone attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final ImmutableDsResponse.Builder from(DsResponse instance)

Fill a builder with attribute values from the provided DsResponse instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

latitude

public final ImmutableDsResponse.Builder latitude(BigDecimal latitude)

Initializes the value for the latitude attribute.

Parameters:

latitude - The value for latitude

Returns:

this builder for use in a chained invocation

longitude

public final ImmutableDsResponse.Builder longitude(BigDecimal longitude)

Initializes the value for the longitude attribute.

Parameters:

longitude - The value for longitude

Returns:

this builder for use in a chained invocation

timezone

public final ImmutableDsResponse.Builder timezone(String timezone)

Initializes the value for the timezone attribute.

Parameters:

timezone - The value for timezone

Returns:

this builder for use in a chained invocation

offset

@Deprecated
public final ImmutableDsResponse.Builder offset(int offset)

Deprecated.

Initializes the value for the offset attribute.

Parameters:

offset - The value for offset

Returns:

this builder for use in a chained invocation

currently

public final ImmutableDsResponse.Builder currently(@Nullable
                                                   DsDataPoint currently)

Initializes the value for the currently attribute.

Parameters:

currently - The value for currently (can be null)

Returns:

this builder for use in a chained invocation

minutely

public final ImmutableDsResponse.Builder minutely(@Nullable
                                                  DsDataBlock minutely)

Initializes the value for the minutely attribute.

Parameters:

minutely - The value for minutely (can be null)

Returns:

this builder for use in a chained invocation

hourly

public final ImmutableDsResponse.Builder hourly(@Nullable
                                                DsDataBlock hourly)

Initializes the value for the hourly attribute.

Parameters:

hourly - The value for hourly (can be null)

Returns:

this builder for use in a chained invocation

daily

public final ImmutableDsResponse.Builder daily(@Nullable
                                               DsDataBlock daily)

Initializes the value for the daily attribute.

Parameters:

daily - The value for daily (can be null)

Returns:

this builder for use in a chained invocation

addAlerts

public final ImmutableDsResponse.Builder addAlerts(DsAlert element)

Adds one element to alerts list.

Parameters:

element - A alerts element

Returns:

this builder for use in a chained invocation

addAlerts

public final ImmutableDsResponse.Builder addAlerts(DsAlert... elements)

Adds elements to alerts list.

Parameters:

elements - An array of alerts elements

Returns:

this builder for use in a chained invocation

alerts

public final ImmutableDsResponse.Builder alerts(Iterable<? extends DsAlert> elements)

Sets or replaces all elements for alerts list.

Parameters:

elements - An iterable of alerts elements

Returns:

this builder for use in a chained invocation

addAllAlerts

public final ImmutableDsResponse.Builder addAllAlerts(Iterable<? extends DsAlert> elements)

Adds elements to alerts list.

Parameters:

elements - An iterable of alerts elements

Returns:

this builder for use in a chained invocation

flags

public final ImmutableDsResponse.Builder flags(@Nullable
                                               DsFlag flags)

Initializes the value for the flags attribute.

Parameters:

flags - The value for flags (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableDsResponse build()

Builds a new ImmutableDsResponse.

Returns:

An immutable instance of DsResponse

Throws:

IllegalStateException - if any required attributes are missing