io.chucknorris.client

Class ChuckNorrisClient

java.lang.Object

io.chucknorris.client.ChuckNorrisClient

public class ChuckNorrisClient
extends java.lang.Object

The official https://api.chucknorris.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

Constructor Summary

Constructors

Constructor and Description
ChuckNorrisClient()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getCategories() Returns a list of available categories.
Joke	getRandomJoke() Returns a random Chuck Norris joke.
Joke	getRandomJoke(java.lang.String category) Returns a random Chuck Norris joke for the given category.
java.util.List<Joke>	searchJokes(java.lang.String query) Searches Chuck Norris jokes 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

Constructor Detail

ChuckNorrisClient

public ChuckNorrisClient()

Method Detail

getCategories

public java.util.List<java.lang.String> getCategories()

Returns a list of available categories. The list is sorted on the count of the categories.

Returns:

the list of available categories

Throws:

ChuckNorrisException - in case an error occurs while retrieving the categories

getRandomJoke

public Joke getRandomJoke()

Returns a random Chuck Norris joke.

Returns:

the random joke

Throws:

ChuckNorrisException - in case an error occurs while retrieving the categories

getRandomJoke

public Joke getRandomJoke(java.lang.String category)

Returns a random Chuck Norris joke for the given category.

Parameters:

category - the category

Returns:

the random joke

Throws:

ChuckNorrisException - in case an error occurs while retrieving the categories

searchJokes

public java.util.List<Joke> searchJokes(java.lang.String query)

Searches Chuck Norris jokes for the given free-text query.

Parameters:

query - the free-text query

Returns:

the list of jokes

Throws:

ChuckNorrisException - in case an error occurs while retrieving the categories