ImmutableDsAlert (Dark Sky API client library 2.0.1 API)

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

All Implemented Interfaces:: DsAlert

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

Immutable implementation of DsAlert.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableDsAlert.Builder
Builds instances of type ImmutableDsAlert.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableDsAlert.Builder`	`builder()` Creates a builder for `ImmutableDsAlert`.
`static ImmutableDsAlert`	`copyOf(DsAlert instance)` Creates an immutable copy of a `DsAlert` value.
`String`	`description()` A detailed description of the alert.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableDsAlert` that have equal attribute values.
`long`	`expires()` The UNIX time at which the alert will expire.
`int`	`hashCode()` Computes a hash code from attributes: `description`, `expires`, `regions`, `severity`, `time`, `title`, `uri`.
`List<String>`	`regions()` A list of `String` representing the names of the regions covered by this weather alert.
`DsAlertSeverity`	`severity()` The severity of the weather alert.
`long`	`time()` The UNIX time at which the alert was issued.
`String`	`title()` A brief description of the alert.
`String`	`toString()` Prints the immutable value `DsAlert` with attribute values.
`String`	`uri()` An HTTP(S) URI that one may refer to for detailed information about the alert.
`ImmutableDsAlert`	`withDescription(String value)` Copy the current immutable object by setting a value for the `description` attribute.
`ImmutableDsAlert`	`withExpires(long value)` Copy the current immutable object by setting a value for the `expires` attribute.
`ImmutableDsAlert`	`withRegions(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `regions`.
`ImmutableDsAlert`	`withRegions(String... elements)` Copy the current immutable object with elements that replace the content of `regions`.
`ImmutableDsAlert`	`withSeverity(DsAlertSeverity value)` Copy the current immutable object by setting a value for the `severity` attribute.
`ImmutableDsAlert`	`withTime(long value)` Copy the current immutable object by setting a value for the `time` attribute.
`ImmutableDsAlert`	`withTitle(String value)` Copy the current immutable object by setting a value for the `title` attribute.
`ImmutableDsAlert`	`withUri(String value)` Copy the current immutable object by setting a value for the `uri` attribute.

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

- Method Detail
  - description
```
public String description()
```
    A detailed description of the alert.
    
    Specified by:
    
    description in interface DsAlert
  - expires
```
public long expires()
```
    The UNIX time at which the alert will expire.
    
    Specified by:
    
    expires in interface DsAlert
  - regions
```
public List<String> regions()
```
    A list of String representing the names of the regions covered by this weather alert.
    
    Specified by:
    
    regions in interface DsAlert
  - severity
```
public DsAlertSeverity severity()
```
    The severity of the weather alert. Will take one of the following values: DsAlertSeverity.ADVISORY (an individual should be aware of potentially severe weather), DsAlertSeverity.WATCH (an individual should prepare for potentially severe weather), or DsAlertSeverity.WARNING (an individual should take immediate action to protect themselves and others from potentially severe weather).
    
    Specified by:
    
    severity in interface DsAlert
  - time
```
public long time()
```
    The UNIX time at which the alert was issued.
    
    Specified by:
    
    time in interface DsAlert
  - title
```
public String title()
```
    A brief description of the alert.
    
    Specified by:
    
    title in interface DsAlert
  - uri
```
public String uri()
```
    An HTTP(S) URI that one may refer to for detailed information about the alert.
    
    Specified by:
    
    uri in interface DsAlert
  - withDescription
```
public final ImmutableDsAlert withDescription(String value)
```
    Copy the current immutable object by setting a value for the description attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for description
    
    Returns:
    
    A modified copy of the this object
  - withExpires
```
public final ImmutableDsAlert withExpires(long value)
```
    Copy the current immutable object by setting a value for the expires attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for expires
    
    Returns:
    
    A modified copy of the this object
  - withRegions
```
public final ImmutableDsAlert withRegions(String... elements)
```
    Copy the current immutable object with elements that replace the content of regions.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withRegions
```
public final ImmutableDsAlert withRegions(Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of regions. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of regions elements to set
    
    Returns:
    
    A modified copy of this object
  - withSeverity
```
public final ImmutableDsAlert withSeverity(DsAlertSeverity value)
```
    Copy the current immutable object by setting a value for the severity attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for severity
    
    Returns:
    
    A modified copy of the this object
  - withTime
```
public final ImmutableDsAlert withTime(long value)
```
    Copy the current immutable object by setting a value for the time attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for time
    
    Returns:
    
    A modified copy of the this object
  - withTitle
```
public final ImmutableDsAlert withTitle(String value)
```
    Copy the current immutable object by setting a value for the title attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for title
    
    Returns:
    
    A modified copy of the this object
  - withUri
```
public final ImmutableDsAlert withUri(String value)
```
    Copy the current immutable object by setting a value for the uri attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for uri
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableDsAlert 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: description, expires, regions, severity, time, title, uri.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value DsAlert with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableDsAlert copyOf(DsAlert instance)
```
    Creates an immutable copy of a DsAlert 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 DsAlert instance
  - builder
```
public static ImmutableDsAlert.Builder builder()
```
    Creates a builder for ImmutableDsAlert.
```
 ImmutableDsAlert.builder()
    .description(String) // required description
    .expires(long) // required expires
    .addRegions|addAllRegions(String) // regions elements
    .severity(ch.rasc.darksky.model.DsAlertSeverity) // required severity
    .time(long) // required time
    .title(String) // required title
    .uri(String) // required uri
    .build();
 
```
    Returns:
    
    A new ImmutableDsAlert builder

Class ImmutableDsAlert

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

description

expires

regions

severity

time

title

uri

withDescription

withExpires

withRegions

withRegions

withSeverity

withTime

withTitle

withUri

equals

hashCode

toString

copyOf

builder