ch.rasc.darksky.model

Class ImmutableDsFlag

java.lang.Object

ch.rasc.darksky.model.ImmutableDsFlag

All Implemented Interfaces:

DsFlag

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

Immutable implementation of DsFlag.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableDsFlag.Builder Builds instances of type ImmutableDsFlag.

Method Summary

Modifier and Type	Method and Description
static ImmutableDsFlag.Builder	builder() Creates a builder for ImmutableDsFlag.
static ImmutableDsFlag	copyOf(DsFlag instance) Creates an immutable copy of a DsFlag value.
Object	darkskyUnavailable() The presence of this property indicates that the Dark Sky data source supports the given location, but a temporary error (such as a radar station being down for maintenance) has made the data unavailable.
boolean	equals(Object another) This instance is equal to all instances of ImmutableDsFlag that have equal attribute values.
int	hashCode() Computes a hash code from attributes: darkskyUnavailable, nearestStation, sources, units.
BigDecimal	nearestStation() The distance to the nearest weather station that contributed data to this response.
List<String>	sources() This property contains a list of IDs for each data source utilized in servicing this request.
String	toString() Prints the immutable value DsFlag with attribute values.
DsUnit	units() Indicates the units which were used for the data in this request.
ImmutableDsFlag	withDarkskyUnavailable(Object value) Copy the current immutable object by setting a value for the darkskyUnavailable attribute.
ImmutableDsFlag	withNearestStation(BigDecimal value) Copy the current immutable object by setting a value for the nearestStation attribute.
ImmutableDsFlag	withSources(Iterable<String> elements) Copy the current immutable object with elements that replace the content of sources.
ImmutableDsFlag	withSources(String... elements) Copy the current immutable object with elements that replace the content of sources.
ImmutableDsFlag	withUnits(DsUnit value) Copy the current immutable object by setting a value for the units attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

darkskyUnavailable

@Nullable
public Object darkskyUnavailable()

The presence of this property indicates that the Dark Sky data source supports the given location, but a temporary error (such as a radar station being down for maintenance) has made the data unavailable.

Specified by:

darkskyUnavailable in interface DsFlag

nearestStation

@Nullable
public BigDecimal nearestStation()

The distance to the nearest weather station that contributed data to this response. Note, however, that many other stations may have also been used; this value is primarily for debugging purposes. This property's value is in miles (if US units are selected) or kilometers (if SI units are selected).

Specified by:

nearestStation in interface DsFlag

sources

public List<String> sources()

This property contains a list of IDs for each data source utilized in servicing this request.

Specified by:

sources in interface DsFlag

units

@Nullable
public DsUnit units()

Indicates the units which were used for the data in this request.

Specified by:

units in interface DsFlag

withDarkskyUnavailable

public final ImmutableDsFlag withDarkskyUnavailable(@Nullable
                                                    Object value)

Copy the current immutable object by setting a value for the darkskyUnavailable attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for darkskyUnavailable (can be null)

Returns:

A modified copy of the this object

withNearestStation

public final ImmutableDsFlag withNearestStation(@Nullable
                                                BigDecimal value)

Copy the current immutable object by setting a value for the nearestStation attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for nearestStation (can be null)

Returns:

A modified copy of the this object

withSources

public final ImmutableDsFlag withSources(String... elements)

Copy the current immutable object with elements that replace the content of sources.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withSources

public final ImmutableDsFlag withSources(Iterable<String> elements)

Copy the current immutable object with elements that replace the content of sources. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of sources elements to set

Returns:

A modified copy of this object

withUnits

public final ImmutableDsFlag withUnits(@Nullable
                                       DsUnit value)

Copy the current immutable object by setting a value for the units attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for units (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 ImmutableDsFlag 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: darkskyUnavailable, nearestStation, sources, units.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value DsFlag with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableDsFlag copyOf(DsFlag instance)

Creates an immutable copy of a DsFlag 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 DsFlag instance

builder

public static ImmutableDsFlag.Builder builder()

Creates a builder for ImmutableDsFlag.

 ImmutableDsFlag.builder()
    .darkskyUnavailable(Object | null) // nullable darkskyUnavailable
    .nearestStation(java.math.BigDecimal | null) // nullable nearestStation
    .addSources|addAllSources(String) // sources elements
    .units(ch.rasc.darksky.model.DsUnit | null) // nullable units
    .build();
 

Returns:

A new ImmutableDsFlag builder