Place (Google Places API 2.1.2 API)

java.lang.Object
- se.walkercrou.places.Place

```
public class Place
extends Object
```
Represents a place returned by Google Places API_

Constructor Summary

Constructors
Modifier Constructor and Description

protected Place()

Constructors
Modifier	Constructor and Description
`protected`	`Place()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Place`	`addAddressComponents(Collection<AddressComponent> c)` Adds a collection of address components to this place.
`protected Place`	`addAltIds(Collection<AltId> altIds)` Adds a collection of `AltId`s.
`protected Place`	`addPhotos(Collection<Photo> photos)` Adds a collection of photos to this place.
`protected Place`	`addReviews(Collection<Review> reviews)` Adds a collection of reviews to this place.
`protected Place`	`addTypes(Collection<String> types)` Adds a collection of string "types".
`Place`	`downloadIcon()` Downloads the icon to this place.
`boolean`	`equals(Object obj)`
`int`	`getAccuracy()` Returns the accuracy of the location, expressed in meters.
`String`	`getAddress()` Returns the address of this place.
`List<AddressComponent>`	`getAddressComponents()` Returns the address components for this place.
`List<AltId>`	`getAltIds()` Returns all of this place's alt-ids in an unmodifiable list.
`GooglePlaces`	`getClient()` Returns the client associated with this Place object.
`Place`	`getDetails(Param... params)` Returns an updated Place object with more details than the Place object returned in an initial query.
`String`	`getGoogleUrl()` Returns the Google PLus page for this place.
`Hours`	`getHours()` Returns the `Hours` for this place.
`BufferedImage`	`getIconImage()` Returns the icon image.
`InputStream`	`getIconInputStream()` Returns the input stream of this place.
`String`	`getIconUrl()` Returns the url of the icon to represent this place.
`String`	`getInternationalPhoneNumber()` Returns the place's phone number with a country code.
`org.json.JSONObject`	`getJson()` Returns the JSON representation of this place.
`String`	`getLanguage()` Returns the language of the place.
`double`	`getLatitude()` Returns the latitude of the place.
`double`	`getLongitude()` Returns the longitude of this place.
`String`	`getName()` Returns the name of this place.
`String`	`getPhoneNumber()` Returns this Place's phone number.
`List<Photo>`	`getPhotos()` Returns the photo references for this place.
`String`	`getPlaceId()` Returns the unique identifier for this place.
`Price`	`getPrice()` Returns the `Price` of this place.
`double`	`getRating()` Returns the rating of this place.
`List<Review>`	`getReviews()` Returns this place's reviews in an unmodifiable list.
`Scope`	`getScope()` Returns the scope of this place.
`Status`	`getStatus()` Returns the `Status` of this place.
`List<String>`	`getTypes()` Returns all of this place's types in an unmodifiable list.
`int`	`getUtcOffset()` Returns the amount of seconds this place is off from the UTC timezone.
`String`	`getVicinity()` Returns the "vicinity" the place is in.
`String`	`getWebsite()` Returns the website of this place.
`boolean`	`isAlwaysOpened()` Returns true if this place is always opened.
`static Place`	`parseDetails(GooglePlaces client, String rawJson)` Parses a detailed Place object.
`protected Place`	`setAccuracy(int accuracy)` Sets the accuracy of the location, expressed in meters.
`protected Place`	`setAddress(String addr)` Sets the address of this place.
`protected Place`	`setClient(GooglePlaces client)` Sets the `GooglePlaces` client associated with this Place object.
`protected Place`	`setGoogleUrl(String googleUrl)` Sets the Google Plus page for this place.
`protected Place`	`setHours(Hours hours)` Sets the `Hours` of this place.
`protected Place`	`setIconUrl(String iconUrl)` Sets the url of the icon to represent this place.
`protected Place`	`setInternationalPhoneNumber(String internationalPhone)` Sets the phone number with an international country code.
`protected Place`	`setJson(org.json.JSONObject json)` Sets the JSON representation of this Place.
`protected Place`	`setLanguage(String lang)` Sets the language of the location.
`protected Place`	`setLatitude(double lat)` Sets the latitude of the place.
`protected Place`	`setLongitude(double lon)` Sets the longitude of this place.
`protected Place`	`setName(String name)` Sets the name of this place.
`protected Place`	`setPhoneNumber(String phone)` Sets this Place's phone number.
`protected Place`	`setPlaceId(String placeId)` Sets the unique, stable, identifier for this place.
`protected Place`	`setPrice(Price price)` Sets the `Price` of this place.
`protected Place`	`setRating(double rating)` Sets the rating of this place.
`protected Place`	`setScope(Scope scope)` Sets the scope of the location.
`protected Place`	`setStatus(Status status)` Sets the `Status` of this place.
`protected Place`	`setUtcOffset(int utcOffset)` Sets the amount of seconds this place is off from the UTC timezone.
`protected Place`	`setVicinity(String vicinity)` Sets the "vicinity" the place is in.
`protected Place`	`setWebsite(String website)` Sets the website url associated with this place.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Place
```
protected Place()
```
- Method Detail
  - parseDetails
```
public static Place parseDetails(GooglePlaces client,
                                 String rawJson)
```
    Parses a detailed Place object.
    
    Parameters:
    
    client - api client
    
    rawJson - json to parse
    
    Returns:
    
    a detailed place
  - getClient
```
public GooglePlaces getClient()
```
    Returns the client associated with this Place object.
    
    Returns:
    
    client
  - setClient
```
protected Place setClient(GooglePlaces client)
```
    Sets the GooglePlaces client associated with this Place object.
    
    Parameters:
    
    client - to set
    
    Returns:
    
    this
  - getPlaceId
```
public String getPlaceId()
```
    Returns the unique identifier for this place.
    
    Returns:
    
    id
  - setPlaceId
```
protected Place setPlaceId(String placeId)
```
    Sets the unique, stable, identifier for this place.
    
    Parameters:
    
    placeId - to use
    
    Returns:
    
    this
  - getLatitude
```
public double getLatitude()
```
    Returns the latitude of the place.
    
    Returns:
    
    place latitude
  - setLatitude
```
protected Place setLatitude(double lat)
```
    Sets the latitude of the place.
    
    Parameters:
    
    lat - latitude
    
    Returns:
    
    this
  - getLongitude
```
public double getLongitude()
```
    Returns the longitude of this place.
    
    Returns:
    
    longitude
  - setLongitude
```
protected Place setLongitude(double lon)
```
    Sets the longitude of this place.
    
    Parameters:
    
    lon - longitude
    
    Returns:
    
    this
  - getUtcOffset
```
public int getUtcOffset()
```
    Returns the amount of seconds this place is off from the UTC timezone.
    
    Returns:
    
    seconds from timezone
  - setUtcOffset
```
protected Place setUtcOffset(int utcOffset)
```
    Sets the amount of seconds this place is off from the UTC timezone.
    
    Parameters:
    
    utcOffset - in seconds
    
    Returns:
    
    this
  - getHours
```
public Hours getHours()
```
    Returns the Hours for this place.
    
    Returns:
    
    hours of operation
  - setHours
```
protected Place setHours(Hours hours)
```
    Sets the Hours of this place.
    
    Parameters:
    
    hours - of operation
    
    Returns:
    
    this
  - isAlwaysOpened
```
public boolean isAlwaysOpened()
```
    Returns true if this place is always opened.
    
    Returns:
    
    true if always opened
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Returns this Place's phone number.
    
    Returns:
    
    number
  - setPhoneNumber
```
protected Place setPhoneNumber(String phone)
```
    Sets this Place's phone number.
    
    Parameters:
    
    phone - number
    
    Returns:
    
    this
  - getInternationalPhoneNumber
```
public String getInternationalPhoneNumber()
```
    Returns the place's phone number with a country code.
    
    Returns:
    
    phone number
  - setInternationalPhoneNumber
```
protected Place setInternationalPhoneNumber(String internationalPhone)
```
    Sets the phone number with an international country code.
    
    Parameters:
    
    internationalPhone - phone number
    
    Returns:
    
    this
  - getGoogleUrl
```
public String getGoogleUrl()
```
    Returns the Google PLus page for this place.
    
    Returns:
    
    plus page
  - setGoogleUrl
```
protected Place setGoogleUrl(String googleUrl)
```
    Sets the Google Plus page for this place.
    
    Parameters:
    
    googleUrl - google plus page
    
    Returns:
    
    this
  - getWebsite
```
public String getWebsite()
```
    Returns the website of this place.
    
    Returns:
    
    website
  - setWebsite
```
protected Place setWebsite(String website)
```
    Sets the website url associated with this place.
    
    Parameters:
    
    website - of place
    
    Returns:
    
    this
  - getVicinity
```
public String getVicinity()
```
    Returns the "vicinity" the place is in. This is sometimes a substitute for address.
    
    Returns:
    
    vicinity
  - setVicinity
```
protected Place setVicinity(String vicinity)
```
    Sets the "vicinity" the place is in. This is sometimes a substitute for address.
    
    Parameters:
    
    vicinity - of place
    
    Returns:
    
    this
  - getIconUrl
```
public String getIconUrl()
```
    Returns the url of the icon to represent this place.
    
    Returns:
    
    icon to represent
  - setIconUrl
```
protected Place setIconUrl(String iconUrl)
```
    Sets the url of the icon to represent this place.
    
    Parameters:
    
    iconUrl - to represent place.
    
    Returns:
    
    this
  - downloadIcon
```
public Place downloadIcon()
```
    Downloads the icon to this place.
    
    Returns:
    
    this
  - getIconInputStream
```
public InputStream getIconInputStream()
```
    Returns the input stream of this place. downloadIcon() must be called previous to call this.
    
    Returns:
    
    input stream
  - getIconImage
```
public BufferedImage getIconImage()
```
    Returns the icon image. downloadIcon() must be called previous to this.
    
    Returns:
    
    image
  - getName
```
public String getName()
```
    Returns the name of this place.
    
    Returns:
    
    name of place
  - setName
```
protected Place setName(String name)
```
    Sets the name of this place.
    
    Parameters:
    
    name - of place
    
    Returns:
    
    this
  - getAddress
```
public String getAddress()
```
    Returns the address of this place.
    
    Returns:
    
    address of this place
  - setAddress
```
protected Place setAddress(String addr)
```
    Sets the address of this place.
    
    Parameters:
    
    addr - address
    
    Returns:
    
    this
  - addAddressComponents
```
protected Place addAddressComponents(Collection<AddressComponent> c)
```
    Adds a collection of address components to this place.
    
    Parameters:
    
    c - components to add
    
    Returns:
    
    this
  - getAddressComponents
```
public List<AddressComponent> getAddressComponents()
```
    Returns the address components for this place.
    
    Returns:
    
    address components
  - addPhotos
```
protected Place addPhotos(Collection<Photo> photos)
```
    Adds a collection of photos to this place.
    
    Parameters:
    
    photos - to add
    
    Returns:
    
    this
  - getPhotos
```
public List<Photo> getPhotos()
```
    Returns the photo references for this place.
    
    Returns:
    
    photos
  - addReviews
```
protected Place addReviews(Collection<Review> reviews)
```
    Adds a collection of reviews to this place.
    
    Parameters:
    
    reviews - to add
    
    Returns:
    
    this
  - getReviews
```
public List<Review> getReviews()
```
    Returns this place's reviews in an unmodifiable list.
    
    Returns:
    
    reviews
  - addTypes
```
protected Place addTypes(Collection<String> types)
```
    Adds a collection of string "types".
    
    Parameters:
    
    types - to add
    
    Returns:
    
    this
  - getTypes
```
public List<String> getTypes()
```
    Returns all of this place's types in an unmodifiable list.
    
    Returns:
    
    types
  - addAltIds
```
protected Place addAltIds(Collection<AltId> altIds)
```
    Adds a collection of AltIds.
    
    Parameters:
    
    altIds - to add
    
    Returns:
    
    this
  - getAltIds
```
public List<AltId> getAltIds()
```
    Returns all of this place's alt-ids in an unmodifiable list.
    
    Returns:
    
    alt-ids
  - getRating
```
public double getRating()
```
    Returns the rating of this place.
    
    Returns:
    
    rating
  - setRating
```
protected Place setRating(double rating)
```
    Sets the rating of this place.
    
    Parameters:
    
    rating - of place
    
    Returns:
    
    this
  - getStatus
```
public Status getStatus()
```
    Returns the Status of this place.
    
    Returns:
    
    status
  - setStatus
```
protected Place setStatus(Status status)
```
    Sets the Status of this place.
    
    Parameters:
    
    status - to set
    
    Returns:
    
    this
  - getPrice
```
public Price getPrice()
```
    Returns the Price of this place.
    
    Returns:
    
    price
  - setPrice
```
protected Place setPrice(Price price)
```
    Sets the Price of this place.
    
    Parameters:
    
    price - to set
    
    Returns:
    
    this
  - getJson
```
public org.json.JSONObject getJson()
```
    Returns the JSON representation of this place. This does not build a JSON object, it only returns the JSON that was given in the initial response from the server.
    
    Returns:
    
    the json representation
  - setJson
```
protected Place setJson(org.json.JSONObject json)
```
    Sets the JSON representation of this Place.
    
    Parameters:
    
    json - representation
    
    Returns:
    
    this
  - getAccuracy
```
public int getAccuracy()
```
    Returns the accuracy of the location, expressed in meters.
    
    Returns:
    
    accuracy of location
  - setAccuracy
```
protected Place setAccuracy(int accuracy)
```
    Sets the accuracy of the location, expressed in meters.
    
    Parameters:
    
    accuracy - of location
    
    Returns:
    
    this
  - getLanguage
```
public String getLanguage()
```
    Returns the language of the place.
    
    Returns:
    
    language
  - setLanguage
```
protected Place setLanguage(String lang)
```
    Sets the language of the location.
    
    Parameters:
    
    lang - place language
    
    Returns:
    
    this
  - getScope
```
public Scope getScope()
```
    Returns the scope of this place.
    
    Returns:
    
    scope
    
    See Also:
    
    Scope
  - setScope
```
protected Place setScope(Scope scope)
```
    Sets the scope of the location.
    
    Parameters:
    
    scope - to set
    
    Returns:
    
    this
    
    See Also:
    
    Scope
  - getDetails
```
public Place getDetails(Param... params)
```
    Returns an updated Place object with more details than the Place object returned in an initial query.
    
    Parameters:
    
    params - extra params to include in the request url
    
    Returns:
    
    a new place with more details
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Place

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Place

Method Detail

parseDetails

getClient

setClient

getPlaceId

setPlaceId

getLatitude

setLatitude

getLongitude

setLongitude

getUtcOffset

setUtcOffset

getHours

setHours

isAlwaysOpened

getPhoneNumber

setPhoneNumber

getInternationalPhoneNumber

setInternationalPhoneNumber

getGoogleUrl

setGoogleUrl

getWebsite

setWebsite

getVicinity

setVicinity

getIconUrl

setIconUrl

downloadIcon

getIconInputStream

getIconImage

getName

setName

getAddress

setAddress

addAddressComponents

getAddressComponents

addPhotos

getPhotos

addReviews

getReviews

addTypes

getTypes

addAltIds

getAltIds

getRating

setRating

getStatus

setStatus

getPrice

setPrice

getJson

setJson

getAccuracy

setAccuracy

getLanguage

setLanguage

getScope

setScope

getDetails

toString

equals