summaryrefslogtreecommitdiff
path: root/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/log/LoggerDefinition.java
diff options
context:
space:
mode:
Diffstat (limited to 'platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/log/LoggerDefinition.java')
-rw-r--r--platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/log/LoggerDefinition.java134
1 files changed, 134 insertions, 0 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/log/LoggerDefinition.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/log/LoggerDefinition.java
new file mode 100644
index 0000000000..27de7349f8
--- /dev/null
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/log/LoggerDefinition.java
@@ -0,0 +1,134 @@
+package com.mapbox.mapboxsdk.log;
+
+import android.util.Log;
+
+/**
+ * Definition of a logger for the Mapbox Maps SDK for Android.
+ */
+public interface LoggerDefinition {
+
+ /**
+ * Send a verbose log message.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ */
+ void v(String tag, String msg);
+
+ /**
+ * Send a verbose log message and log the exception.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ * @param tr An exception to log
+ */
+ void v(String tag, String msg, Throwable tr);
+
+ /**
+ * Send a debug log message.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ */
+ void d(String tag, String msg);
+
+ /**
+ * Send a debug log message and log the exception.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ * @param tr An exception to log
+ */
+ void d(String tag, String msg, Throwable tr);
+
+ /**
+ * Send an info log message.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ */
+ void i(String tag, String msg);
+
+ /**
+ * Send an info log message and log the exception.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ * @param tr An exception to log
+ */
+ void i(String tag, String msg, Throwable tr);
+
+ /**
+ * Send a warning log message.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ */
+ void w(String tag, String msg);
+
+ /**
+ * Send a warning log message and log the exception.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ * @param tr An exception to log
+ */
+ void w(String tag, String msg, Throwable tr);
+
+ /**
+ * Send an error log message.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ */
+ void e(String tag, String msg);
+
+ /**
+ * Send an error log message and log the exception.
+ *
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param msg The message you would like logged.
+ * @param tr An exception to log
+ */
+ void e(String tag, String msg, Throwable tr);
+
+ /**
+ * Send a log message based on severity.
+ *
+ * @param severity the log severity
+ * @param tag Used to identify the source of a log message. It usually identifies
+ * the class or activity where the log call occurs.
+ * @param message The message you would like logged.
+ */
+ static void log(int severity, String tag, String message) {
+ switch (severity) {
+ case Log.VERBOSE:
+ Logger.v(tag, message);
+ break;
+ case Log.DEBUG:
+ Logger.d(tag, message);
+ break;
+ case Log.INFO:
+ Logger.i(tag, message);
+ break;
+ case Log.WARN:
+ Logger.w(tag, message);
+ break;
+ case Log.ERROR:
+ Logger.e(tag, message);
+ break;
+ default:
+ throw new UnsupportedOperationException();
+ }
+ }
+} \ No newline at end of file