Подключение библиотеки для использования в Java-приложениях

Шаблон подключения данной библиотеки для разработки Java-приложений с использованием конфигурационного Maven-файла pom.xml представлен ниже:

<project>
    ...
    <dependencies>
        <dependency>
            <groupId>org.hedgecode.snooker</groupId>
            <artifactId>snooker-score-api</artifactId>
            <version>0.2</version>
        </dependency>
    </dependencies>
    ...
</project>

Примечание: Maven 3.0 будет выдавать предупреждение, если вы не укажите версию плагина.

Работа с Java-кодом библиотеки

После подключения библиотеки к проекту можно начинать работать с её кодом.
Для того, чтобы получить экземпляр основного интерфейса библиотеки, нужно выполнить следующий код:

SnookerScoreAPI api = Snooker.API();

SnookerScoreAPI представляет собой интерфейс с набором всех основных методов, которые позволяют через объекты-сущности получить доступ к информации о сезонах, турнирах, матчах, игроках и их рейтингах.

Библиотека предоставляет две реализации вышеуказанного интерфейса: с кэшированием данных по игрокам и событиям (турнирам) внутри библиотеки и без кэширования. Реализация интерфейса с кэшированием является реализацией "по умолчанию".
Доступ к каждой из двух реализаций интерфейса может быть получен путём выполнения следующих вызовов:

SnookerScoreAPI cachedApi = Snooker.cachedAPI(); /* API with cache */
...
SnookerScoreAPI uncachedApi = Snooker.uncachedAPI(); /* API without cache */

Дальнейшая работа с библиотекой представляет собой последовательность вызовов методов интерфейса SnookerScoreAPI для получения списков турниров, игроков, текущих матчей и прочей статистической информации.
Например, чтобы получить информацию по матчам, проходящим в данный момент, достаточно выполнить следующий код:

SnookerScoreAPI api = Snooker.API();
OngoingMatches matches = api.getOngoingMatches();

Описание работы большинства методов интерфейса можно найти в разделе ЧаВо, а на страницах с примерами рассмотрены наиболее часто встречающиеся ситуации. Сигнатура методов, а также информация по другим сущностям библиотеки, представлена в JavaDoc.

Запуск библиотеки из командной строки

В данной библиотеке имеется возможность произвести запуск из командной строки для проверки корректности соединения с информационным порталом snooker.org. Запуск библиотеки из командной строки осуществляется следующим образом:

java -jar snooker-score-api-0.2.jar

Если программа отработает корректно, то можно будет увидеть список текущих и предстоящих турниров по снукеру.  Примерный результат вывода программы представлен ниже:

********************************************************************************
                    Welcome to Hedgecode Snooker Score API!
                -----------------------------------------------
         It is an API library for portal snooker.org, which contains
      the results of snooker competitions and other snooker information.
    This library provides a set of entity objects that can be used in client
    applications (to inform about the results of snooker), developed in Java.
********************************************************************************
  Current Snooker Events:
     China Open Qualifiers [24.01.2017 - 27.01.2017] (England, Preston)
********************************************************************************
  Upcoming Snooker Events:
     German Masters [01.02.2017 - 05.02.2017] (Germany, Berlin)
     World Grand Prix [06.02.2017 - 12.02.2017] (England, Preston)
     Welsh Open [13.02.2017 - 19.02.2017] (Wales, Cardiff)
     Connie Gough Memorial Trophy [18.02.2017 - 18.02.2017] (England, Dunstable)
     Championship League - Group 5 [20.02.2017 - 21.02.2017] (England, Coventry)
********************************************************************************