Package com.aerisweather.aeris.communication.parameter

Class RadiusParameter

java.lang.Object

com.aerisweather.aeris.communication.parameter.Parameter

com.aerisweather.aeris.communication.parameter.RadiusParameter

public class RadiusParameter
extends Parameter

When requesting the closest results within a circle, the radius determines how far from the specified location to search. A valid unit value must be included in your radius value, e.g., "5mi", "10km", "50miles". If no unit is provided, your value is assumed to be in meters by default. The default radius is 50 miles if not specified.

Field Summary

Fields inherited from class com.aerisweather.aeris.communication.parameter.Parameter

key, value

Constructor Summary

Constructors

Constructor	Description
RadiusParameter(int distance)	Constructs a Radius parameter of a certain distance.
RadiusParameter(int distance, RadiusUnit unit)	Constructs a Radius parameter of a certain distance.
RadiusParameter(String value)	Construct a radius paramter with the string as the value.

Method Summary

Methods inherited from class com.aerisweather.aeris.communication.parameter.Parameter

build, buildEscaped

Methods inherited from class java.lang.Object

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

Constructor Detail

RadiusParameter

public RadiusParameter(int distance)

Constructs a Radius parameter of a certain distance. Will default to meters.

Parameters:

distance - distance to use in meters.

RadiusParameter

public RadiusParameter(int distance,
                       RadiusUnit unit)

Constructs a Radius parameter of a certain distance.

Parameters:

distance - distance to use.

unit - unit type to use

RadiusParameter

public RadiusParameter(String value)

Construct a radius paramter with the string as the value.

Parameters:

value - value to use