ch.rasc.darksky.model

Class ImmutableDsDataBlock

java.lang.Object

ch.rasc.darksky.model.ImmutableDsDataBlock

All Implemented Interfaces:

DsDataBlock

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

Immutable implementation of DsDataBlock.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableDsDataBlock.Builder	builder() Creates a builder for ImmutableDsDataBlock.
static ImmutableDsDataBlock	copyOf(DsDataBlock instance) Creates an immutable copy of a DsDataBlock value.
List<DsDataPoint>	data() A list of DsDataPoint instances, ordered by time, which together describe the weather conditions at the requested location over time.
boolean	equals(Object another) This instance is equal to all instances of ImmutableDsDataBlock that have equal attribute values.
int	hashCode() Computes a hash code from attributes: summary, icon, data.
DsIcon	icon() A machine-readable text summary of this data block.
String	summary() A human-readable summary of this data block.
String	toString() Prints the immutable value DsDataBlock with attribute values.
ImmutableDsDataBlock	withData(DsDataPoint... elements) Copy the current immutable object with elements that replace the content of data.
ImmutableDsDataBlock	withData(Iterable<? extends DsDataPoint> elements) Copy the current immutable object with elements that replace the content of data.
ImmutableDsDataBlock	withIcon(DsIcon value) Copy the current immutable object by setting a value for the icon attribute.
ImmutableDsDataBlock	withSummary(String value) Copy the current immutable object by setting a value for the summary attribute.

Methods inherited from class java.lang.Object

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

Method Detail

summary

@Nullable
public String summary()

A human-readable summary of this data block.

Specified by:

summary in interface DsDataBlock

icon

@Nullable
public DsIcon icon()

A machine-readable text summary of this data block. (May take on the same values as DsDataPoint.icon().)

Specified by:

icon in interface DsDataBlock

data

public List<DsDataPoint> data()

A list of DsDataPoint instances, ordered by time, which together describe the weather conditions at the requested location over time.

Specified by:

data in interface DsDataBlock

withSummary

public final ImmutableDsDataBlock withSummary(@Nullable
                                              String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withIcon

public final ImmutableDsDataBlock withIcon(@Nullable
                                           DsIcon value)

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

Parameters:

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

Returns:

A modified copy of the this object

withData

public final ImmutableDsDataBlock withData(DsDataPoint... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withData

public final ImmutableDsDataBlock withData(Iterable<? extends DsDataPoint> elements)

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

Parameters:

elements - An iterable of data elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableDsDataBlock 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: summary, icon, data.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value DsDataBlock with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableDsDataBlock copyOf(DsDataBlock instance)

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

builder

public static ImmutableDsDataBlock.Builder builder()

Creates a builder for ImmutableDsDataBlock.

 ImmutableDsDataBlock.builder()
    .summary(String | null) // nullable summary
    .icon(ch.rasc.darksky.model.DsIcon | null) // nullable icon
    .addData|addAllData(ch.rasc.darksky.model.DsDataPoint) // data elements
    .build();
 

Returns:

A new ImmutableDsDataBlock builder