From 732eb2850bffc39e946899bf55eb0aff46926c36 Mon Sep 17 00:00:00 2001 From: Rubenlagus Date: Wed, 28 Sep 2016 00:41:06 +0200 Subject: [PATCH] 1. Add docs --- .../api/interfaces/{IValidable.java => Validable.java} | 6 +++--- .../telegrambots/api/methods/BotApiMethod.java | 4 ++-- .../telegrambots/api/objects/games/CallbackGame.java | 4 ++-- .../inputmessagecontent/InputMessageContent.java | 4 ++-- .../objects/inlinequery/result/InlineQueryResult.java | 4 ++-- .../api/objects/replykeyboard/ReplyKeyboard.java | 4 ++-- .../replykeyboard/buttons/InlineKeyboardButton.java | 4 ++-- .../objects/replykeyboard/buttons/KeyboardButton.java | 4 ++-- .../api/objects/replykeyboard/buttons/KeyboardRow.java | 4 ++-- .../telegrambots/bots/ITelegramWebhookBot.java | 10 ++++++---- .../telegrambots/bots/TelegramLongPollingBot.java | 3 ++- .../telegram/telegrambots/bots/TelegramWebhookBot.java | 3 ++- .../telegrambots/exceptions/TelegramApiException.java | 2 +- .../telegram/telegrambots/logging/BotsFileHandler.java | 2 +- .../telegram/telegrambots/logging/FileFormatter.java | 2 +- 15 files changed, 32 insertions(+), 28 deletions(-) rename src/main/java/org/telegram/telegrambots/api/interfaces/{IValidable.java => Validable.java} (84%) diff --git a/src/main/java/org/telegram/telegrambots/api/interfaces/IValidable.java b/src/main/java/org/telegram/telegrambots/api/interfaces/Validable.java similarity index 84% rename from src/main/java/org/telegram/telegrambots/api/interfaces/IValidable.java rename to src/main/java/org/telegram/telegrambots/api/interfaces/Validable.java index 29b95925..e1f2b1d1 100644 --- a/src/main/java/org/telegram/telegrambots/api/interfaces/IValidable.java +++ b/src/main/java/org/telegram/telegrambots/api/interfaces/Validable.java @@ -22,12 +22,12 @@ import org.telegram.telegrambots.exceptions.TelegramApiValidationException; /** * @author Ruben Bermudez * @version 1.0 - * @brief TODO + * @brief Interface that can be implemented by objects that knows how to validate their fields * @date 16 of September of 2016 */ -public interface IValidable { +public interface Validable { /** - * Validates that mandatory fields are filled + * Validates that mandatory fields are filled and optional objects * @throws TelegramApiValidationException If any mandatory field is empty */ void validate() throws TelegramApiValidationException; diff --git a/src/main/java/org/telegram/telegrambots/api/methods/BotApiMethod.java b/src/main/java/org/telegram/telegrambots/api/methods/BotApiMethod.java index d5f7be31..3380b582 100644 --- a/src/main/java/org/telegram/telegrambots/api/methods/BotApiMethod.java +++ b/src/main/java/org/telegram/telegrambots/api/methods/BotApiMethod.java @@ -4,7 +4,7 @@ import com.fasterxml.jackson.databind.JsonSerializable; import org.json.JSONObject; import org.telegram.telegrambots.api.interfaces.IToJson; -import org.telegram.telegrambots.api.interfaces.IValidable; +import org.telegram.telegrambots.api.interfaces.Validable; import java.io.Serializable; @@ -14,7 +14,7 @@ import java.io.Serializable; * @brief A method of Telegram Bots Api that is fully supported in json format * @date 07 of September of 2015 */ -public abstract class BotApiMethod implements JsonSerializable, IToJson, IValidable { +public abstract class BotApiMethod implements JsonSerializable, IToJson, Validable { protected static final String METHOD_FIELD = "method"; /** diff --git a/src/main/java/org/telegram/telegrambots/api/objects/games/CallbackGame.java b/src/main/java/org/telegram/telegrambots/api/objects/games/CallbackGame.java index c2a45e0c..7eb90d97 100644 --- a/src/main/java/org/telegram/telegrambots/api/objects/games/CallbackGame.java +++ b/src/main/java/org/telegram/telegrambots/api/objects/games/CallbackGame.java @@ -24,7 +24,7 @@ import com.fasterxml.jackson.databind.jsontype.TypeSerializer; import org.json.JSONObject; import org.telegram.telegrambots.api.interfaces.IBotApiObject; -import org.telegram.telegrambots.api.interfaces.IValidable; +import org.telegram.telegrambots.api.interfaces.Validable; import org.telegram.telegrambots.exceptions.TelegramApiValidationException; import java.io.IOException; @@ -35,7 +35,7 @@ import java.io.IOException; * @brief This object contains information about a game that will be returned as a response to a callback query. * @date 16 of September of 2016 */ -public class CallbackGame implements IBotApiObject, IValidable { +public class CallbackGame implements IBotApiObject, Validable { private static final String TITLE_FIELD = "title"; private static final String ID_FIELD = "game_id"; private static final String START_PARAMETER_FIELD = "start_parameter"; diff --git a/src/main/java/org/telegram/telegrambots/api/objects/inlinequery/inputmessagecontent/InputMessageContent.java b/src/main/java/org/telegram/telegrambots/api/objects/inlinequery/inputmessagecontent/InputMessageContent.java index ce512a60..8575d4a0 100644 --- a/src/main/java/org/telegram/telegrambots/api/objects/inlinequery/inputmessagecontent/InputMessageContent.java +++ b/src/main/java/org/telegram/telegrambots/api/objects/inlinequery/inputmessagecontent/InputMessageContent.java @@ -2,7 +2,7 @@ package org.telegram.telegrambots.api.objects.inlinequery.inputmessagecontent; import org.telegram.telegrambots.api.interfaces.IBotApiObject; import org.telegram.telegrambots.api.interfaces.IToJson; -import org.telegram.telegrambots.api.interfaces.IValidable; +import org.telegram.telegrambots.api.interfaces.Validable; /** * @author Ruben Bermudez @@ -11,5 +11,5 @@ import org.telegram.telegrambots.api.interfaces.IValidable; * query. * @date 10 of April of 2016 */ -public interface InputMessageContent extends IBotApiObject, IToJson, IValidable { +public interface InputMessageContent extends IBotApiObject, IToJson, Validable { } diff --git a/src/main/java/org/telegram/telegrambots/api/objects/inlinequery/result/InlineQueryResult.java b/src/main/java/org/telegram/telegrambots/api/objects/inlinequery/result/InlineQueryResult.java index 38ee3505..a744ca89 100644 --- a/src/main/java/org/telegram/telegrambots/api/objects/inlinequery/result/InlineQueryResult.java +++ b/src/main/java/org/telegram/telegrambots/api/objects/inlinequery/result/InlineQueryResult.java @@ -2,7 +2,7 @@ package org.telegram.telegrambots.api.objects.inlinequery.result; import org.telegram.telegrambots.api.interfaces.IBotApiObject; import org.telegram.telegrambots.api.interfaces.IToJson; -import org.telegram.telegrambots.api.interfaces.IValidable; +import org.telegram.telegrambots.api.interfaces.Validable; /** * @author Ruben Bermudez @@ -10,5 +10,5 @@ import org.telegram.telegrambots.api.interfaces.IValidable; * @brief This object represents one result of an inline query. * @date 01 of January of 2016 */ -public interface InlineQueryResult extends IBotApiObject, IToJson, IValidable { +public interface InlineQueryResult extends IBotApiObject, IToJson, Validable { } diff --git a/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/ReplyKeyboard.java b/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/ReplyKeyboard.java index 0d784d7a..aa2d01c3 100644 --- a/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/ReplyKeyboard.java +++ b/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/ReplyKeyboard.java @@ -2,7 +2,7 @@ package org.telegram.telegrambots.api.objects.replykeyboard; import org.telegram.telegrambots.api.interfaces.IBotApiObject; import org.telegram.telegrambots.api.interfaces.IToJson; -import org.telegram.telegrambots.api.interfaces.IValidable; +import org.telegram.telegrambots.api.interfaces.Validable; /** * @author Ruben Bermudez @@ -10,5 +10,5 @@ import org.telegram.telegrambots.api.interfaces.IValidable; * @brief Reply keyboard abstract type * @date 20 of June of 2015 */ -public interface ReplyKeyboard extends IBotApiObject, IToJson, IValidable { +public interface ReplyKeyboard extends IBotApiObject, IToJson, Validable { } diff --git a/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/InlineKeyboardButton.java b/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/InlineKeyboardButton.java index 607fd6e2..6a044534 100644 --- a/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/InlineKeyboardButton.java +++ b/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/InlineKeyboardButton.java @@ -8,7 +8,7 @@ import com.fasterxml.jackson.databind.jsontype.TypeSerializer; import org.json.JSONObject; import org.telegram.telegrambots.api.interfaces.IBotApiObject; import org.telegram.telegrambots.api.interfaces.IToJson; -import org.telegram.telegrambots.api.interfaces.IValidable; +import org.telegram.telegrambots.api.interfaces.Validable; import org.telegram.telegrambots.api.objects.games.CallbackGame; import org.telegram.telegrambots.exceptions.TelegramApiValidationException; @@ -23,7 +23,7 @@ import java.io.IOException; * display unsupported message. * @date 10 of April of 2016 */ -public class InlineKeyboardButton implements IBotApiObject, IToJson, IValidable { +public class InlineKeyboardButton implements IBotApiObject, IToJson, Validable { private static final String TEXT_FIELD = "text"; private static final String URL_FIELD = "url"; diff --git a/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/KeyboardButton.java b/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/KeyboardButton.java index 7a031570..644677a2 100644 --- a/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/KeyboardButton.java +++ b/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/KeyboardButton.java @@ -8,7 +8,7 @@ import com.fasterxml.jackson.databind.jsontype.TypeSerializer; import org.json.JSONObject; import org.telegram.telegrambots.api.interfaces.IBotApiObject; import org.telegram.telegrambots.api.interfaces.IToJson; -import org.telegram.telegrambots.api.interfaces.IValidable; +import org.telegram.telegrambots.api.interfaces.Validable; import org.telegram.telegrambots.exceptions.TelegramApiValidationException; import java.io.IOException; @@ -23,7 +23,7 @@ import java.io.IOException; * after 9 April, 2016. Older clients will ignore them. * @date 10 of April of 2016 */ -public class KeyboardButton implements IBotApiObject, IToJson, IValidable { +public class KeyboardButton implements IBotApiObject, IToJson, Validable { private static final String TEXT_FIELD = "text"; private static final String REQUEST_CONTACT_FIELD = "request_contact"; diff --git a/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/KeyboardRow.java b/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/KeyboardRow.java index ffd3dddb..4cdf618f 100644 --- a/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/KeyboardRow.java +++ b/src/main/java/org/telegram/telegrambots/api/objects/replykeyboard/buttons/KeyboardRow.java @@ -1,6 +1,6 @@ package org.telegram.telegrambots.api.objects.replykeyboard.buttons; -import org.telegram.telegrambots.api.interfaces.IValidable; +import org.telegram.telegrambots.api.interfaces.Validable; import org.telegram.telegrambots.exceptions.TelegramApiValidationException; import java.util.ArrayList; @@ -11,7 +11,7 @@ import java.util.ArrayList; * @brief Row for ReplyKeyBoardMarkup * @date 10 of April of 2016 */ -public class KeyboardRow extends ArrayList implements IValidable { +public class KeyboardRow extends ArrayList implements Validable { public boolean add(String text) { return super.add(new KeyboardButton(text)); } diff --git a/src/main/java/org/telegram/telegrambots/bots/ITelegramWebhookBot.java b/src/main/java/org/telegram/telegrambots/bots/ITelegramWebhookBot.java index 5a639c6c..33987096 100644 --- a/src/main/java/org/telegram/telegrambots/bots/ITelegramWebhookBot.java +++ b/src/main/java/org/telegram/telegrambots/bots/ITelegramWebhookBot.java @@ -17,18 +17,20 @@ public interface ITelegramWebhookBot { BotApiMethod onWebhookUpdateReceived(Update update); /** - * Return bot username of this bot + * Gets bot username of this bot + * @return Bot username */ String getBotUsername(); /** - * Return bot token to access Telegram API + * Gets bot token to access Telegram API + * @return Bot token */ String getBotToken(); /** - * TODO - * @return + * Gets in the url for the webhook + * @return path in the url */ String getBotPath(); } diff --git a/src/main/java/org/telegram/telegrambots/bots/TelegramLongPollingBot.java b/src/main/java/org/telegram/telegrambots/bots/TelegramLongPollingBot.java index 40915803..6d4b8da5 100644 --- a/src/main/java/org/telegram/telegrambots/bots/TelegramLongPollingBot.java +++ b/src/main/java/org/telegram/telegrambots/bots/TelegramLongPollingBot.java @@ -3,7 +3,8 @@ package org.telegram.telegrambots.bots; /** * @author Ruben Bermudez * @version 1.0 - * @brief TODO + * @brief Base abstract class for a bot that will get updates using + * long-polling method * @date 14 of January of 2016 */ public abstract class TelegramLongPollingBot extends AbsSender implements ITelegramLongPollingBot { diff --git a/src/main/java/org/telegram/telegrambots/bots/TelegramWebhookBot.java b/src/main/java/org/telegram/telegrambots/bots/TelegramWebhookBot.java index b3f41afb..a5e7bdc7 100644 --- a/src/main/java/org/telegram/telegrambots/bots/TelegramWebhookBot.java +++ b/src/main/java/org/telegram/telegrambots/bots/TelegramWebhookBot.java @@ -3,7 +3,8 @@ package org.telegram.telegrambots.bots; /** * @author Ruben Bermudez * @version 1.0 - * @brief TODO + * @brief Base abstract class for a bot that will receive updates using a + * webhook * @date 14 of January of 2016 */ public abstract class TelegramWebhookBot extends AbsSender implements ITelegramWebhookBot { diff --git a/src/main/java/org/telegram/telegrambots/exceptions/TelegramApiException.java b/src/main/java/org/telegram/telegrambots/exceptions/TelegramApiException.java index aa51328b..3bc0176a 100644 --- a/src/main/java/org/telegram/telegrambots/exceptions/TelegramApiException.java +++ b/src/main/java/org/telegram/telegrambots/exceptions/TelegramApiException.java @@ -20,7 +20,7 @@ package org.telegram.telegrambots.exceptions; /** * @author Ruben Bermudez * @version 1.0 - * @brief TODO + * @brief Base class for any exception from TelegramBots api * @date 16 of September of 2016 */ public class TelegramApiException extends Exception { diff --git a/src/main/java/org/telegram/telegrambots/logging/BotsFileHandler.java b/src/main/java/org/telegram/telegrambots/logging/BotsFileHandler.java index c225f497..6a2c8cd2 100644 --- a/src/main/java/org/telegram/telegrambots/logging/BotsFileHandler.java +++ b/src/main/java/org/telegram/telegrambots/logging/BotsFileHandler.java @@ -6,7 +6,7 @@ import java.util.logging.FileHandler; /** * @author Ruben Bermudez * @version 1.0 - * @brief TODO + * @brief Handler to use a file as logs destination with {@link BotLogger} * @date 19 of May of 2016 */ public class BotsFileHandler extends FileHandler { diff --git a/src/main/java/org/telegram/telegrambots/logging/FileFormatter.java b/src/main/java/org/telegram/telegrambots/logging/FileFormatter.java index a36da759..aec305b5 100644 --- a/src/main/java/org/telegram/telegrambots/logging/FileFormatter.java +++ b/src/main/java/org/telegram/telegrambots/logging/FileFormatter.java @@ -8,7 +8,7 @@ import java.util.logging.LogRecord; /** * @author Ruben Bermudez * @version 1.0 - * @brief TODO + * @brief Formatter for {@link BotsFileHandler} * @date 19 of May of 2016 */ class FileFormatter extends Formatter {