org.springframework.social.twitter.api

Class Place

java.lang.Object

org.springframework.social.twitter.api.TwitterObject

org.springframework.social.twitter.api.Place

public class Place
extends TwitterObject

Represents a place that a Twitter user may send a tweet from.

Author:

Craig Walls

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Place.Geometry Represents a place's geometry.
static class	Place.GeometryType
static class	Place.GeoPoint Represents a point in geospace (e.g., latitude/longitude)

Constructor Summary

Constructors

Constructor and Description
Place(String id, String name, String fullName, String streetAddress, String country, String countryCode, PlaceType placeType)

Method Summary

Methods

Modifier and Type	Method and Description
List<Place.GeoPoint>	getBoundingBox()
List<Place>	getContainedWithin()
String	getCountry()
String	getCountryCode()
String	getFullName()
Place.Geometry	getGeometry()
String	getId()
String	getName()
PlaceType	getPlaceType()
String	getStreetAddress()

Methods inherited from class org.springframework.social.twitter.api.TwitterObject

add, getExtraData

Methods inherited from class java.lang.Object

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

Constructor Detail

Place

public Place(String id,
     String name,
     String fullName,
     String streetAddress,
     String country,
     String countryCode,
     PlaceType placeType)

Method Detail

getId

public String getId()

Returns:

the place's ID.

getName

public String getName()

Returns:

a brief name for the place.

getFullName

public String getFullName()

Returns:

the full name for the place.

getStreetAddress

public String getStreetAddress()

Returns:

the place's street address. May be null.

getCountry

public String getCountry()

Returns:

the place's country.

getCountryCode

public String getCountryCode()

Returns:

the place's country code.

getPlaceType

public PlaceType getPlaceType()

Returns:

the place type.

getContainedWithin

public List<Place> getContainedWithin()

Returns:

a list of other places that this place is contained within.

getBoundingBox

public List<Place.GeoPoint> getBoundingBox()

Returns:

a list of points defining a box that fully contains the place's geometry.

getGeometry

public Place.Geometry getGeometry()

Returns:

the place's geometry.