com.github.fedy2.weather.data.Location Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yahoo-weather-java-api Show documentation

A Java library for the yahoo weather RSS feed service

The newest version!

/**
 * 
 */
package com.github.fedy2.weather.data;

import javax.xml.bind.annotation.*;

/**
 * Weather location.
 * @author "Federico De Faveri [email protected]"
 */
@XmlRootElement
public class Location {
	
	/**
	 * City name.
	 */
	@XmlAttribute
	private String city;
	
	/**
	 * State, territory, or region, if given
	 */
	@XmlAttribute
	private String region;
	
	/**
	 * Two-character country code.
	 */
	@XmlAttribute
	private String country;

	public Location(){}
	
	/**
	 * @param city the city name.
	 * @param region the state, territory, or region.
	 * @param country the two-character country code.
	 */
	public Location(String city, String region, String country) {
		this.city = city;
		this.region = region;
		this.country = country;
	}

	/**
	 * Returns the city name.
	 * @return the city name.
	 */
	public String getCity() {
		return city;
	}

	/**
	 * Returns the state, territory, or region, if given
	 * @return the region
	 */
	public String getRegion() {
		return region;
	}

	/**
	 * Returns the two-character country code.
	 * @return the country
	 */
	public String getCountry() {
		return country;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString() {
		StringBuilder builder = new StringBuilder();
		builder.append("Location [city=");
		builder.append(city);
		builder.append(", region=");
		builder.append(region);
		builder.append(", country=");
		builder.append(country);
		builder.append("]");
		return builder.toString();
	}
}