Skip to content

Commit c17a580

Browse files
More javadocs to ExtractorLogger
1 parent b89a8ba commit c17a580

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

extractor/src/main/java/org/schabi/newpipe/extractor/utils/ExtractorLogger.java

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
11
package org.schabi.newpipe.extractor.utils;
22

3+
/**
4+
* Logging class for outputting logs from the extractor to the desired output<br><br>
5+
* Intended to be used in the same manner as Android's {@code Log}:<br>
6+
* {@code ExtractorLogger.d("Hello my name Jeff")}<br>
7+
* <br>
8+
* Also supports formatted arguments:<br>
9+
* {@code ExtractorLogger.d("Hello my name is {Name} {}", name, surname)}
10+
*/
311
public final class ExtractorLogger {
412

513
private ExtractorLogger() { }
614

715
private static final Logger EMPTY_LOGGER = new EmptyLogger();
816
private static volatile Logger logger = EMPTY_LOGGER;
917

18+
/**
19+
* Set the Logger that you want the extractor logs to be logged to
20+
* <br>
21+
* Provide an implementation of the {@code Logger} interface for each method and whenever the
22+
* extractor code calls {@code ExtractorLogger.d/w/e}
23+
* it will be routed through to {@code customLogger}
24+
* <br>
25+
* <br>
26+
* For NewPipe, this should be set at the start of the application ideally in
27+
* {@code MainActivity.onCreate}, but absolutely before any extractor code can run
28+
*/
1029
public static void setLogger(final Logger customLogger) {
1130
logger = customLogger != null ? customLogger : EMPTY_LOGGER;
1231
}
@@ -44,6 +63,9 @@ private static void log(final Level level,
4463
}
4564
}
4665

66+
/***
67+
* Internal method for logging with formatting
68+
*/
4769
@SuppressWarnings("checkstyle:NeedBraces")
4870
private static void logFormat(final Level level,
4971
final String tag,

0 commit comments

Comments
 (0)