demus/Gadgetbridge
1
0
Fork 0
mirror of https://codeberg.org/Freeyourgadget/Gadgetbridge.git synced 2026-07-31 07:44:24 +02:00
Code Issues 1 Packages Projects Releases Wiki Activity

GB.toast: improve JavaDoc

Browse Source
This commit is contained in:
Thomas Kuehne
2026-05-28 23:26:38 +00:00
parent 7832f8a4a8
commit 38e43a32b6
1 changed files with 39 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/src/main/java/nodomain/freeyourgadget/gadgetbridge/util/GB.java
+39 -20
View File
@@ -463,57 +463,74 @@ public class GB {
}
/**
* Creates and display a Toast message using the application context.
* Additionally the toast is logged using the provided severity.
* Can be called from any thread.
* Creates and display a {@link Toast} message using the {@link GBApplication}'s {@link Context}.
* Additionally, the message is logged using the provided severity.
* Can be called from any {@link Thread}.
*
* @param message the message to display.
* @param displayTime something like Toast.LENGTH_SHORT
* @param severity either INFO, WARNING, ERROR
* @param message the message to display
* @param displayTime either {@link Toast#LENGTH_SHORT} or {@link Toast#LENGTH_LONG}
* @param severity either {@link #DEBUG}, {@link #INFO}, {@link #WARN} or {@link #ERROR}
* @see #toast(Context, String, int, int, Throwable)
*/
public static void toast(String message, int displayTime, int severity) {
toast(GBApplication.getContext(), message, displayTime, severity, null);
}
/**
* Creates and display a Toast message using the application context.
* Additionally the toast is logged using the provided severity.
* Can be called from any thread.
* Creates and display a {@link Toast} message using the {@link GBApplication}'s {@link Context}.
* Additionally, the message is logged using the provided severity.
* Can be called from any {@link Thread}.
*
* @param message the message to display.
* @param displayTime something like Toast.LENGTH_SHORT
* @param severity either INFO, WARNING, ERROR
* @param displayTime either {@link Toast#LENGTH_SHORT} or {@link Toast#LENGTH_LONG}
* @param severity either {@link #DEBUG}, {@link #INFO}, {@link #WARN} or {@link #ERROR}
* @param ex optional {@link Throwable} to be logged
* @see #toast(Context, String, int, int, Throwable)
*/
public static void toast(String message, int displayTime, int severity, Throwable ex) {
toast(GBApplication.getContext(), message, displayTime, severity, ex);
}
/**
* Creates and display a Toast message using the application context
* Can be called from any thread.
* Creates and display a {@link Toast} message using the provided context.
* Additionally, the message is logged using the provided severity.
* Can be called from any {@link Thread}.
*
* @param context the context to use
* @param message the message to display
* @param displayTime something like Toast.LENGTH_SHORT
* @param severity either INFO, WARNING, ERROR
* @param displayTime either {@link Toast#LENGTH_SHORT} or {@link Toast#LENGTH_LONG}
* @param severity either {@link #DEBUG}, {@link #INFO}, {@link #WARN} or {@link #ERROR}
* @see #toast(Context, String, int, int, Throwable)
*/
public static void toast(final Context context, final String message, final int displayTime, final int severity) {
toast(context, message, displayTime, severity, null);
}
/**
* Creates and display a {@link Toast} message using the provided context.
* Additionally, the message is logged using the provided severity.
* Can be called from any {@link Thread}.
*
* @param context the context to use
* @param message the message to display
* @param displayTime either {@link Toast#LENGTH_SHORT} or {@link Toast#LENGTH_LONG}
* @param severity either {@link #DEBUG}, {@link #INFO}, {@link #WARN} or {@link #ERROR}
* @see #toast(Context, String, int, int, Throwable)
*/
public static void toast(final Context context, @StringRes final int message, final int displayTime, final int severity) {
toast(context, context.getString(message), displayTime, severity, null);
}
/**
* Creates and display a Toast message using the application context
* Can be called from any thread.
* Creates and display a {@link Toast} message using the provided context.
* Additionally, the message is logged using the provided severity.
* Can be called from any {@link Thread}.
*
* @param context the context to use
* @param message the message to display
* @param displayTime something like Toast.LENGTH_SHORT
* @param severity either INFO, WARNING, ERROR
* @param ex optional exception to be logged
* @param displayTime something like {@link Toast#LENGTH_SHORT} or {@link Toast#LENGTH_LONG}
* @param severity either {@link #DEBUG}, {@link #INFO}, {@link #WARN} or {@link #ERROR}
* @param ex optional {@link Throwable} to be logged
*/
public static void toast(final Context context, final String message, final int displayTime, final int severity, final Throwable ex) {
log(message, severity, ex); // log immediately, not delayed
@@ -534,10 +551,12 @@ public class GB {
}
}
/// @param severity either {@link #DEBUG}, {@link #INFO}, {@link #WARN} or {@link #ERROR}
public static void log(String message, int severity, Throwable ex) {
log(LOG, message, severity, ex);
}
/// @param severity either {@link #DEBUG}, {@link #INFO}, {@link #WARN} or {@link #ERROR}
public static void log(Logger logger, String message, int severity, Throwable ex) {
switch (severity) {
case INFO: