com.twitter.hbc.core.endpoint

Class BaseEndpoint

java.lang.Object

com.twitter.hbc.core.endpoint.BaseEndpoint

All Implemented Interfaces:

Endpoint

Direct Known Subclasses:

DefaultStreamingEndpoint

public class BaseEndpoint
extends Object
implements Endpoint

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiVersion
protected String	httpMethod
protected String	path
protected ConcurrentMap<String,String>	postParameters
protected ConcurrentMap<String,String>	queryParameters

Constructor Summary

Constructors

Constructor and Description
BaseEndpoint(String path, String httpMethod)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDefaultParams()
void	addPostParameter(String param, String value)
void	addQueryParameter(String param, String value)
protected String	generateParamString(Map<String,String> params)
String	getHttpMethod()
String	getPath()
String	getPath(String apiVersion)
String	getPostParamString() Returns the string format of the post parameters for this endpoint, if applicable
String	getQueryParamString()
String	getURI()
void	removePostParameter(String param)
void	removeQueryParameter(String param)
void	setApiVersion(String apiVersion)

Methods inherited from class java.lang.Object

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

Field Detail

queryParameters

protected final ConcurrentMap<String,String> queryParameters

postParameters

protected final ConcurrentMap<String,String> postParameters

path

protected final String path

httpMethod

protected final String httpMethod

apiVersion

protected volatile String apiVersion

Constructor Detail

BaseEndpoint

public BaseEndpoint(String path,
            String httpMethod)

Method Detail

getPath

public String getPath(String apiVersion)

getPath

public final String getPath()

getURI

public String getURI()

Specified by:

getURI in interface Endpoint

addDefaultParams

protected void addDefaultParams()

generateParamString

protected String generateParamString(Map<String,String> params)

getQueryParamString

public String getQueryParamString()

Specified by:

getQueryParamString in interface Endpoint

getPostParamString

public String getPostParamString()

Description copied from interface: Endpoint

Returns the string format of the post parameters for this endpoint, if applicable

Specified by:

getPostParamString in interface Endpoint

getHttpMethod

public String getHttpMethod()

Specified by:

getHttpMethod in interface Endpoint

addPostParameter

public void addPostParameter(String param,
                    String value)

Specified by:

addPostParameter in interface Endpoint

removePostParameter

public void removePostParameter(String param)

Specified by:

removePostParameter in interface Endpoint

addQueryParameter

public void addQueryParameter(String param,
                     String value)

Specified by:

addQueryParameter in interface Endpoint

removeQueryParameter

public void removeQueryParameter(String param)

Specified by:

removeQueryParameter in interface Endpoint

setApiVersion

public void setApiVersion(String apiVersion)