org.springframework.social.twitter.api
Class Place

java.lang.Object
  extended by org.springframework.social.twitter.api.TwitterObject
      extended by org.springframework.social.twitter.api.Place

public class Place
extends TwitterObject

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


Nested Class Summary
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
Place(String id, String name, String fullName, String streetAddress, String country, String countryCode, PlaceType placeType)
           
 
Method Summary
 List<Place.GeoPoint> getBoundingBox()
          A list of points defining a box that fully contains the place's geometry.
 List<Place> getContainedWithin()
          A list of other places that this place is contained within.
 String getCountry()
          The place's country.
 String getCountryCode()
          The place's country code.
 String getFullName()
          The full name for the place.
 Place.Geometry getGeometry()
          The place's geometry.
 String getId()
          The place's ID.
 String getName()
          A brief name for the place.
 PlaceType getPlaceType()
          The place type.
 String getStreetAddress()
          The place's street address.
 
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()
The place's ID.


getName

public String getName()
A brief name for the place.


getFullName

public String getFullName()
The full name for the place.


getStreetAddress

public String getStreetAddress()
The place's street address. May be null.


getCountry

public String getCountry()
The place's country.


getCountryCode

public String getCountryCode()
The place's country code.


getPlaceType

public PlaceType getPlaceType()
The place type.


getContainedWithin

public List<Place> getContainedWithin()
A list of other places that this place is contained within.


getBoundingBox

public List<Place.GeoPoint> getBoundingBox()
A list of points defining a box that fully contains the place's geometry.


getGeometry

public Place.Geometry getGeometry()
The place's geometry.