com.github.michaelbull.rs

Interface Client

All Known Implementing Classes:

HttpClient

public interface Client

Represents a client that can deserialize JSON and CSV resources into Java Objects.

Field Summary

Fields

Modifier and Type	Field and Description
static CSVFormat	CSV_FORMAT The comma-separated CSV format.

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.

Field Detail

CSV_FORMAT

static final CSVFormat CSV_FORMAT

The comma-separated CSV format.

Method Detail

fromJson

<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.

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 an 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

<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.

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

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

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

Parameters:

url - The URL to deserialize from.

Returns:

An ImmutableList of CSVRecords.

Throws:

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