ApiMethod (robinhood-api 0.8.4 API)

java.lang.Object
- com.ampro.robinhood.net.ApiMethod

Direct Known Subclasses:

Account, Authorize, GetFundamental, GetInstrument, GetOptionsMethod, GetQuote, OrderMethod, Paginate
```
public abstract class ApiMethod
extends java.lang.Object
```
A Wrapper object for making REST requests through Unirest

Field Summary

Fields
Modifier and Type Field and Description

protected Configuration config

static int MAX_TICKERS

protected static RequestManager reqMan

static java.lang.String RH_URL

Fields
Modifier and Type	Field and Description
`protected Configuration`	`config`
`static int`	`MAX_TICKERS`
`protected static RequestManager`	`reqMan`
`static java.lang.String`	`RH_URL`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ApiMethod(Configuration config)
Constructor which stores the service which is being used

Constructors
Modifier	Constructor and Description
`protected`	`ApiMethod(Configuration config)` Constructor which stores the service which is being used

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAuthTokenParameter()` Method which adds the Authorization Token to the HTTP request header
`protected void`	`addFieldParameter(java.lang.String key, java.lang.Object val)` Add a field key-val pair
`protected void`	`addFieldParameters(java.util.Map<java.lang.String,java.lang.Object> paramMap)` Add predefined field key-val pairs
`protected void`	`addHeaderParameter(java.lang.String key, java.lang.String value)` A methodType which adds a HttpHeaderParameter to the API request header
`protected void`	`addHeaderParameters(java.util.Map<java.lang.String,java.lang.String> paramMap)` A methodType which adds HttpHeaderParameters to the API request header
`protected void`	`addQueryParameter(java.lang.String key, java.lang.Object value)` Add a Query key-value pair
`protected void`	`addQueryParameters(java.util.Map<java.lang.String,java.lang.Object> paramMap)` Add predefined query key-val pairs
`protected void`	`addRouteParameter(java.lang.String key, java.lang.String value)` Add a route parameter.
`protected void`	`addRoutParameters(java.util.Map<java.lang.String,java.lang.String> paramMap)` Add multiple Route parameters from a `Map` (written in the `urlBase` as http://url.com/{routeKey}
`<E extends ApiElement> E`	`execute()` Execute the method request.
`java.lang.String`	`getBaseUrl()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getFieldParameters()`
`java.util.HashMap<java.lang.String,java.lang.String>`	`getHeaderParameters()`
`RequestMethod`	`getMethodType()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getQueryParameters()`
`java.lang.reflect.Type`	`getReturnType()`
`java.util.HashMap<java.lang.String,java.lang.String>`	`getRouteParameters()`
`boolean`	`requiresToken()`
`protected void`	`requireToken()` Method to set the request to require an AuthToken
`protected void`	`setMethodType(RequestMethod methodType)` Set the request method type
`protected void`	`setReturnType(java.lang.reflect.Type returnType)`
`protected void`	`setUrlBase(java.lang.String urlBase)` Method which sets the URL base.
`java.lang.String`	`toString()` As this is an abstract methodType, this override gets the name of the implementing class

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

- Field Detail
  - RH_URL
```
public static final java.lang.String RH_URL
```
    See Also:
    
    Constant Field Values
  - MAX_TICKERS
```
public static final int MAX_TICKERS
```
    See Also:
    
    Constant Field Values
  - reqMan
```
protected static final RequestManager reqMan
```
  - config
```
protected final Configuration config
```
- Constructor Detail
  - ApiMethod
```
protected ApiMethod(Configuration config)
```
    Constructor which stores the service which is being used
    
    Parameters:
    
    config - A Configuration
- Method Detail
  - execute
```
public <E extends ApiElement> E execute()
```
    Execute the method request. This is alternative to using the RequestManager directly.
    
    Type Parameters:
    
    E - The return ApiElement
    
    Returns:
    
    The requested ApiElement or null
  - addHeaderParameter
```
protected void addHeaderParameter(java.lang.String key,
                                  java.lang.String value)
```
    A methodType which adds a HttpHeaderParameter to the API request header
    
    Parameters:
    
    key - The key to map to
    
    value - The value to map
  - addHeaderParameters
```
protected void addHeaderParameters(java.util.Map<java.lang.String,java.lang.String> paramMap)
```
    A methodType which adds HttpHeaderParameters to the API request header
    
    Parameters:
    
    paramMap - A String-String map of Key-Val pairs
  - addRouteParameter
```
protected void addRouteParameter(java.lang.String key,
                                 java.lang.String value)
```
    Add a route parameter. (written in the urlBase as http://url.com/{routeKey}
    
    Parameters:
    
    key - The key to map to
    
    value - The value to map
  - addRoutParameters
```
protected void addRoutParameters(java.util.Map<java.lang.String,java.lang.String> paramMap)
```
    Add multiple Route parameters from a Map (written in the urlBase as http://url.com/{routeKey}
    
    Parameters:
    
    paramMap - A String-String map of Key-Val pairs
  - addQueryParameter
```
protected void addQueryParameter(java.lang.String key,
                                 java.lang.Object value)
```
    Add a Query key-value pair
    
    Parameters:
    
    key - The key to map to
    
    value - The value to map
  - addQueryParameters
```
protected void addQueryParameters(java.util.Map<java.lang.String,java.lang.Object> paramMap)
```
    Add predefined query key-val pairs
    
    Parameters:
    
    paramMap - A Map of String keys and Object values
  - addFieldParameter
```
protected void addFieldParameter(java.lang.String key,
                                 java.lang.Object val)
```
    Add a field key-val pair
    
    Parameters:
    
    key - The key to map to
    
    val - The value to map
  - addFieldParameters
```
protected void addFieldParameters(java.util.Map<java.lang.String,java.lang.Object> paramMap)
```
    Add predefined field key-val pairs
    
    Parameters:
    
    paramMap - A String-Object map of Key-Val pairs
  - addAuthTokenParameter
```
public void addAuthTokenParameter()
```
    Method which adds the Authorization Token to the HTTP request header
    
    Throws:
    
    NotLoggedInException - if the token does not exist or If the user is not logged in.
  - getHeaderParameters
```
public java.util.HashMap<java.lang.String,java.lang.String> getHeaderParameters()
```
    Returns:
    
    the header parameters of the method
  - getRouteParameters
```
public java.util.HashMap<java.lang.String,java.lang.String> getRouteParameters()
```
    Returns:
    
    The route parameters of the method
  - getQueryParameters
```
public java.util.Map<java.lang.String,java.lang.Object> getQueryParameters()
```
    Returns:
    
    The query parameters of the method
  - getFieldParameters
```
public java.util.Map<java.lang.String,java.lang.Object> getFieldParameters()
```
    Returns:
    
    The field parameters of the method
  - getReturnType
```
public java.lang.reflect.Type getReturnType()
```
    Returns:
    
    ReturnType
  - getMethodType
```
public RequestMethod getMethodType()
```
    Returns:
    
    The request RequestMethod of this ApiMethod
  - getBaseUrl
```
public java.lang.String getBaseUrl()
```
    Returns:
    
    The base URL with any route parameter keys
  - requireToken
```
protected void requireToken()
```
    Method to set the request to require an AuthToken
  - requiresToken
```
public boolean requiresToken()
```
    Returns:
    
    true if this ApiMethod requires an authorization token (i.e. logged in instance)
  - setMethodType
```
protected void setMethodType(RequestMethod methodType)
```
    Set the request method type
    
    Parameters:
    
    methodType - The RequestMethod to set to
  - setReturnType
```
protected void setReturnType(java.lang.reflect.Type returnType)
```
    Parameters:
    
    returnType - The return type of the ApiMethod
  - setUrlBase
```
protected void setUrlBase(java.lang.String urlBase)
```
    Method which sets the URL base. For example, it will probably always be "api.robinhood.com/" This exists however for flexibility
    
    Parameters:
    
    urlBase - The base URL, including any route parameters
  - toString
```
public java.lang.String toString()
```
    As this is an abstract methodType, this override gets the name of the implementing class
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The classes simple-name

Class ApiMethod

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RH_URL

MAX_TICKERS

reqMan

config

Constructor Detail

ApiMethod

Method Detail

execute

addHeaderParameter

addHeaderParameters

addRouteParameter

addRoutParameters

addQueryParameter

addQueryParameters

addFieldParameter

addFieldParameters

addAuthTokenParameter

getHeaderParameters

getRouteParameters

getQueryParameters

getFieldParameters

getReturnType

getMethodType

getBaseUrl

requireToken

requiresToken

setMethodType

setReturnType

setUrlBase

toString