SearchParameters (Spring Social Twitter 2.0.0.BUILD-SNAPSHOT API)

java.lang.Object
- org.springframework.social.twitter.api.SearchParameters

```
public class SearchParameters
extends Object
```
Twitter search parameters. See specifications: https://dev.twitter.com/docs/api/1.1/get/search/tweets

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SearchParameters.ResultType
ResultType enumeration.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchParameters.ResultType` ResultType enumeration.

Constructor Summary

Constructors
Constructor and Description

SearchParameters(String query)
Constructs SearchParameter object

Constructors
Constructor and Description
`SearchParameters(String query)` Constructs SearchParameter object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchParameters`	`count(int count)` Sets optional `count` parameter.
`boolean`	`equals(Object o)`
`SearchParameters`	`geoCode(GeoCode geoCode)` Sets optional `geocode` parameter.
`Integer`	`getCount()` Returns `count` search parameter
`GeoCode`	`getGeoCode()` Returns `geo_code` search parameter
`String`	`getLang()` Returns `lang` search parameter
`String`	`getLocale()` Returns `locale` search parameter
`Long`	`getMaxId()` Returns `max_id` search parameter
`String`	`getQuery()` Returns query, `q` parameter
`SearchParameters.ResultType`	`getResultType()` Returns `result_type` search parameter
`Long`	`getSinceId()` Returns `since_id` search parameter
`Date`	`getUntil()` Returns `until` search parameter
`int`	`hashCode()`
`SearchParameters`	`includeEntities(boolean includeEntities)` Sets optional `include_entities` parameter.
`boolean`	`isIncludeEntities()` Returns `include_entities` search parameter
`SearchParameters`	`lang(String lang)` Sets optional `lang` parameter.
`SearchParameters`	`locale(String locale)` Sets optional `locale` parameter.
`SearchParameters`	`maxId(long maxId)` Sets optional `max_id` parameter.
`SearchParameters`	`resultType(SearchParameters.ResultType resultType)` Sets optional `result_type` parameter.
`SearchParameters`	`sinceId(long sinceId)` Sets optional `since_id` parameter.
`SearchParameters`	`until(Date untilDate)` Sets optional `until` parameter.

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

- Constructor Detail
  - SearchParameters
```
public SearchParameters(String query)
```
    Constructs SearchParameter object
    
    Parameters:
    
    query - Search keywords
- Method Detail
  - geoCode
```
public SearchParameters geoCode(GeoCode geoCode)
```
    Sets optional geocode parameter. Restricts tweets by users located within a given radius of the given latitude/longitude.
    
    Parameters:
    
    geoCode - GeoCode object stuffed with coordinates and radius
    
    Returns:
    
    The same SearchParameters for additional configuration.
    
    See Also:
    
    GeoCode
  - lang
```
public SearchParameters lang(String lang)
```
    Sets optional lang parameter. Restricts tweets to the given language, given by an ISO 639-1 code.
    
    Parameters:
    
    lang - an ISO 639-1 language code
    
    Returns:
    
    The same SearchParameters for additional configuration.
  - locale
```
public SearchParameters locale(String locale)
```
    Sets optional locale parameter. Specify the language of the query you are sending (only ja is currently effective).
    
    Parameters:
    
    locale - locale
    
    Returns:
    
    The same SearchParameters for additional configuration.
  - resultType
```
public SearchParameters resultType(SearchParameters.ResultType resultType)
```
    Sets optional result_type parameter. Specifies what type of search results. Default is mixed.
    
    Parameters:
    
    resultType - type of preferred result type
    
    Returns:
    
    The same SearchParameters for additional configuration.
    
    See Also:
    
    SearchParameters.ResultType
  - count
```
public SearchParameters count(int count)
```
    Sets optional count parameter. Restricts the number of tweets to return, up to a maximum of 100. Defaults to 15.
    
    Parameters:
    
    count - number of tweets to return
    
    Returns:
    
    The same SearchParameters for additional configuration.
  - until
```
public SearchParameters until(Date untilDate)
```
    Sets optional until parameter. Restricts search to tweets generated before the given date.
    
    Parameters:
    
    untilDate - date to search until
    
    Returns:
    
    The same SearchParameters for additional configuration.
  - sinceId
```
public SearchParameters sinceId(long sinceId)
```
    Sets optional since_id parameter. Restricts search results with an ID greater than the specified one.
    
    Parameters:
    
    sinceId - The minimum Tweet ID to return in the results
    
    Returns:
    
    The same SearchParameters for additional configuration.
  - maxId
```
public SearchParameters maxId(long maxId)
```
    Sets optional max_id parameter. Restricts search results with an ID less or equel than the specified one.
    
    Parameters:
    
    maxId - The maximum Tweet ID to return in the results
    
    Returns:
    
    The same SearchParameters for additional configuration.
  - includeEntities
```
public SearchParameters includeEntities(boolean includeEntities)
```
    Sets optional include_entities parameter. The entities node will be excluded when set to false.
    
    Parameters:
    
    includeEntities - Include entities node
    
    Returns:
    
    The same SearchParameters for additional configuration.
  - getQuery
```
public String getQuery()
```
    Returns query, q parameter
    
    Returns:
    
    query
  - getGeoCode
```
public GeoCode getGeoCode()
```
    Returns geo_code search parameter
    
    Returns:
    
    geoCode
  - getLang
```
public String getLang()
```
    Returns lang search parameter
    
    Returns:
    
    lang
  - getLocale
```
public String getLocale()
```
    Returns locale search parameter
    
    Returns:
    
    locale
  - getResultType
```
public SearchParameters.ResultType getResultType()
```
    Returns result_type search parameter
    
    Returns:
    
    result_type
  - getCount
```
public Integer getCount()
```
    Returns count search parameter
    
    Returns:
    
    count
  - getUntil
```
public Date getUntil()
```
    Returns until search parameter
    
    Returns:
    
    until
  - getSinceId
```
public Long getSinceId()
```
    Returns since_id search parameter
    
    Returns:
    
    since_id
  - getMaxId
```
public Long getMaxId()
```
    Returns max_id search parameter
    
    Returns:
    
    max_id
  - isIncludeEntities
```
public boolean isIncludeEntities()
```
    Returns include_entities search parameter
    
    Returns:
    
    include_entities
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class SearchParameters

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchParameters

Method Detail

geoCode

lang

locale

resultType

count

until

sinceId

maxId

includeEntities

getQuery

getGeoCode

getLang

getLocale

getResultType

getCount

getUntil

getSinceId

getMaxId

isIncludeEntities

equals

hashCode