com.sun.syndication.feed.module.yahooweather.types
Class Forecast

java.lang.Object
  com.sun.syndication.feed.module.yahooweather.types.Forecast

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Forecast
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

The weather forecast for a specific day. The item element contains multiple forecast elements for today and tomorrow. Attributes:

• day: day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string)
• date: the date to which this forecast applies. The date is in "dd Mmm yyyy" format, for example "30 Nov 2005" (string)
• low: the forecasted low temperature for this day, in the units specified by the yweather:units element (integer)
• high: the forecasted high temperature for this day, in the units specified by the yweather:units element (integer)
• text: a textual description of conditions, for example, "Partly Cloudy" (string)
• code: the condition code for this forecast. You could use this code to choose a text description or image for the forecast. The possible values for this element are described in Condition Codes (integer)

Version:

$Id: Forecast.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $

Author:

Robert "kebernet" Cooper

See Also:

ConditionCode, Serialized Form

Constructor Summary

Forecast()
Simple constructor.

Forecast(java.lang.String day, java.util.Date date, int low, int high, java.lang.String text, ConditionCode code)
Constructs a new Forecast object.

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object o)
ConditionCode	getCode() Condition code
java.util.Date	getDate() For date.
java.lang.String	getDay() Day of week
int	getHigh() High temperature
int	getLow() Low temperature.
java.lang.String	getText() Text summary
int	hashCode()
void	setCode(ConditionCode code) Condition code
void	setDate(java.util.Date date) For date.
void	setDay(java.lang.String day) Day of week
void	setHigh(int high) High temperature
void	setLow(int low) Low temperature
void	setText(java.lang.String text) Text summary
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Forecast

public Forecast()

Simple constructor.

Forecast

public Forecast(java.lang.String day,
                java.util.Date date,
                int low,
                int high,
                java.lang.String text,
                ConditionCode code)

Constructs a new Forecast object.

Parameters:

day - day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string)

date - the date to which this forecast applies

low - the forecasted low temperature for this day

high - the forecasted high temperature for this day

text - a textual description of conditions, for example, "Partly Cloudy"

code - ConditionCode instance for this forcast.

Method Detail

getDay

public java.lang.String getDay()

Day of week

Returns:

day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string)

setDay

public void setDay(java.lang.String day)

Day of week

Parameters:

day - day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string)

getDate

public java.util.Date getDate()

For date.

Returns:

the date to which this forecast applies

setDate

public void setDate(java.util.Date date)

For date.

Parameters:

date - the date to which this forecast applies

getLow

public int getLow()

Low temperature.

Returns:

the forecasted low temperature for this day

See Also:

Units

setLow

public void setLow(int low)

Low temperature

Parameters:

low - the forecasted low temperature for this day

See Also:

Units

getHigh

public int getHigh()

High temperature

Returns:

the forecasted high temperature for this day

See Also:

Units

setHigh

public void setHigh(int high)

High temperature

Parameters:

high - the forecasted high temperature for this day

See Also:

Units

getText

public java.lang.String getText()

Text summary

Returns:

a textual description of conditions, for example, "Partly Cloudy"

setText

public void setText(java.lang.String text)

Text summary

Parameters:

text - a textual description of conditions, for example, "Partly Cloudy"

getCode

public ConditionCode getCode()

Condition code

Returns:

the condition code for this forecast

setCode

public void setCode(ConditionCode code)

Condition code

Parameters:

code - the condition code for this forecast

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object