com.github.michaelbull.rs

Class HttpClient

java.lang.Object

com.github.michaelbull.rs.HttpClient

All Implemented Interfaces:

Client

public final class HttpClient
extends java.lang.Object
implements Client

A Client that wraps a HttpClient to interact with the RuneScape web-services API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WEB_SERVICES_URL The URL to the RuneScape public web-services.

Fields inherited from interface com.github.michaelbull.rs.Client

CSV_FORMAT

Constructor Summary

Constructors

Constructor and Description
HttpClient()

Method Summary

Modifier and Type	Method and Description
ImmutableList<CSVRecord>	fromCSV(java.lang.String url) Deserializes a CSV file from a specified URL into an ImmutableList of CSVRecords.
<T> java.util.Optional<T>	fromJson(java.lang.String url, java.lang.Class<T> classOfT) Deserializes a JSON file from a specified URL into an object of the specified type.
<T> java.util.Optional<T>	fromJson(java.lang.String url, java.lang.reflect.Type typeOfT) Deserializes a JSON file from a specified URL into an object of the specified type.

Methods inherited from class java.lang.Object

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

Field Detail

WEB_SERVICES_URL

public static final java.lang.String WEB_SERVICES_URL

The URL to the RuneScape public web-services.

See Also:

Constant Field Values

Constructor Detail

HttpClient

public HttpClient()

Method Detail

fromJson

public <T> java.util.Optional<T> fromJson(java.lang.String url,
                                          java.lang.reflect.Type typeOfT)
                                   throws java.io.IOException

Deserializes a JSON file from a specified URL into an object of the specified type.

Specified by:

fromJson in interface Client

Type Parameters:

T - The type of the desired object

Parameters:

url - The URL to deserialize from.

typeOfT - The specific genericized type of src.

Returns:

An Optional containing object of type T from the json, or Optional.empty() if the URL could not be deserialized.

Throws:

java.io.IOException - If an I/O error occurs.

fromJson

public <T> java.util.Optional<T> fromJson(java.lang.String url,
                                          java.lang.Class<T> classOfT)
                                   throws java.io.IOException

Deserializes a JSON file from a specified URL into an object of the specified type.

Specified by:

fromJson in interface Client

Type Parameters:

T - The type of the desired object

Parameters:

url - The URL to deserialize from.

classOfT - The class of T.

Returns:

An optional of object of type T from the json, or Optional.empty() if the URL could not be deserialized.

Throws:

java.io.IOException - If an I/O error occurs.

fromCSV

public ImmutableList<CSVRecord> fromCSV(java.lang.String url)
                                 throws java.io.IOException

Deserializes a CSV file from a specified URL into an ImmutableList of CSVRecords.

Specified by:

fromCSV in interface Client

Parameters:

url - The URL to deserialize from.

Returns:

An ImmutableList of CSVRecords.

Throws:

java.io.IOException - If an I/O error occurs.