io.tronalddump.client

Class TronaldClient

java.lang.Object

io.tronalddump.client.TronaldClient

public class TronaldClient
extends java.lang.Object

The official https://api.tronalddump.io Java client.

Since:

1.0.0

Author:

Marcel Overdijk

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE_URL
static java.text.DateFormat	DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
TronaldClient()

Method Summary

Modifier and Type	Method and Description
Quote	getQuote(java.lang.String id) Returns the quote for the given id.
Quote	getRandomQuote() Returns a random quote.
Quote	getRandomQuote(java.lang.String tag) Returns a random quote with the given tag.
java.util.List<java.lang.String>	getTags() Returns a list of available tags.
Page<Quote>	search(java.lang.String query) Returns a page of quotes for the given free text query.
Page<Quote>	search(java.lang.String query, int size) Returns a page of quotes for the given free text query.
Page<Quote>	search(java.lang.String query, int page, int size) Returns a page of quotes for the given free text query.
Page<Quote>	search(java.lang.String query, Pageable pageable) Returns a page of quotes for the given free text query.

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URL

public static final java.lang.String BASE_URL

See Also:

Constant Field Values

DATE_FORMAT

public static final java.text.DateFormat DATE_FORMAT

Constructor Detail

TronaldClient

public TronaldClient()

Method Detail

getTags

public java.util.List<java.lang.String> getTags()
                                         throws TronaldException

Returns a list of available tags.

Returns:

the list of available tags

Throws:

TronaldException - in case an error occurs while retrieving the tags

getQuote

public Quote getQuote(java.lang.String id)
               throws TronaldException

Returns the quote for the given id.

Parameters:

id - the unique quote id, not null

Returns:

the quote

Throws:

TronaldException - in case an error occurs while retrieving the quote

getRandomQuote

public Quote getRandomQuote()
                     throws TronaldException

Returns a random quote.

Returns:

the quote

Throws:

TronaldException - in case an error occurs while retrieving the random quote

getRandomQuote

public Quote getRandomQuote(java.lang.String tag)
                     throws TronaldException

Returns a random quote with the given tag.

Parameters:

tag - the tag

Returns:

the quote

Throws:

TronaldException - in case an error occurs while retrieving the random quote

search

public Page<Quote> search(java.lang.String query)
                   throws TronaldException

Returns a page of quotes for the given free text query.

Parameters:

query - the free text query, not null

Returns:

the page of quotes

Throws:

TronaldException - in case an error occurs while retrieving the random quote

search

public Page<Quote> search(java.lang.String query,
                          int size)
                   throws TronaldException

Returns a page of quotes for the given free text query.

Parameters:

query - the free text query, not null

size - the page size

Returns:

the page of quotes

Throws:

TronaldException - in case an error occurs while retrieving the random quote

search

public Page<Quote> search(java.lang.String query,
                          int page,
                          int size)
                   throws TronaldException

Returns a page of quotes for the given free text query.

Parameters:

query - the free text query, not null

page - the page number

size - the page size

Returns:

the page of quotes

Throws:

TronaldException - in case an error occurs while retrieving the random quote

search

public Page<Quote> search(java.lang.String query,
                          Pageable pageable)
                   throws TronaldException

Returns a page of quotes for the given free text query.

Parameters:

query - the free text query, not null

pageable - the pagination information, not null

Returns:

the page of quotes

Throws:

TronaldException - in case an error occurs while retrieving the random quote