-
Notifications
You must be signed in to change notification settings - Fork 21
/
Logger.java
186 lines (169 loc) · 5.82 KB
/
Logger.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*
* Copyright 2018 Kaushik N. Sanji
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.example.kaushiknsanji.storeapp.utils;
import android.util.Log;
import static com.example.kaushiknsanji.storeapp.utils.AppConstants.DEBUG;
/**
* Class that allows logging statements which acts as a wrapper to {@link android.util.Log}
* in order enable logging only in debuggable build types.
*
* @author Kaushik N Sanji
*/
public final class Logger {
/**
* Private Constructor to avoid instantiating {@link Logger}
*/
private Logger() {
//Suppressing with an error to enforce noninstantiability
throw new AssertionError("No " + this.getClass().getCanonicalName() + " instances for you!");
}
/**
* Send a {@link Log#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.
*/
public static void v(String tag, String msg) {
if (DEBUG) {
Log.v(tag, msg);
}
}
/**
* Send a {@link Log#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
*/
public static void v(String tag, String msg, Throwable tr) {
if (DEBUG) {
Log.v(tag, msg, tr);
}
}
/**
* Send a {@link Log#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.
*/
public static void d(String tag, String msg) {
if (DEBUG) {
Log.d(tag, msg);
}
}
/**
* Send a {@link Log#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
*/
public static void d(String tag, String msg, Throwable tr) {
if (DEBUG) {
Log.d(tag, msg, tr);
}
}
/**
* Send an {@link Log#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.
*/
public static void i(String tag, String msg) {
if (DEBUG) {
Log.i(tag, msg);
}
}
/**
* Send a {@link Log#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
*/
public static void i(String tag, String msg, Throwable tr) {
if (DEBUG) {
Log.i(tag, msg, tr);
}
}
/**
* Send a {@link Log#WARN} 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.
*/
public static void w(String tag, String msg) {
if (DEBUG) {
Log.w(tag, msg);
}
}
/**
* Send a {@link Log#WARN} 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
*/
public static void w(String tag, String msg, Throwable tr) {
if (DEBUG) {
Log.w(tag, msg, tr);
}
}
/*
* Send a {@link Log#WARN} 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 tr An exception to log
*/
public static void w(String tag, Throwable tr) {
if (DEBUG) {
Log.w(tag, tr);
}
}
/**
* Send an {@link Log#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.
*/
public static void e(String tag, String msg) {
if (DEBUG) {
Log.e(tag, msg);
}
}
/**
* Send a {@link Log#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
*/
public static void e(String tag, String msg, Throwable tr) {
if (DEBUG) {
Log.e(tag, msg, tr);
}
}
}