28
28
* For example, all {@code Exception}s can be logged using this handler even if
29
29
* {@link Subscriber#onError(Throwable)} is ignored or not provided when an {@link Observable} is subscribed to.
30
30
* <p>
31
- * This plugin is also responsible for augmenting rendering of {@link OnErrorThrowable.OnNextValue}.
31
+ * This plugin is also responsible for augmenting rendering of {@code OnErrorThrowable.OnNextValue}.
32
32
* <p>
33
33
* See {@link RxJavaPlugins} or the RxJava GitHub Uncyclo for information on configuring plugins: <a
34
34
* href="https://github.com/ReactiveX/RxJava/wiki/Plugins">https://github.com/ReactiveX/RxJava/wiki/Plugins</a>.
@@ -52,17 +52,21 @@ public void handleError(Throwable e) {
52
52
protected static final String ERROR_IN_RENDERING_SUFFIX = ".errorRendering" ;
53
53
54
54
/**
55
- * Receives items causing {@link OnErrorThrowable.OnNextValue} and gives a chance to choose the String
56
- * representation of the item in the OnNextValue stacktrace rendering. Returns null if this type of item
57
- * is not managed and should use default rendering.
55
+ * Receives items causing {@code OnErrorThrowable.OnNextValue} and gives a chance to choose the String
56
+ * representation of the item in the {@code OnNextValue} stacktrace rendering. Returns {@code null} if this
57
+ * type of item is not managed and should use default rendering.
58
58
* <p>
59
- * Note that primitive types are always rendered as their toString() value.
59
+ * Note that primitive types are always rendered as their {@code toString()} value.
60
60
* <p>
61
61
* If a {@code Throwable} is caught when rendering, this will fallback to the item's classname suffixed by
62
62
* {@value #ERROR_IN_RENDERING_SUFFIX}.
63
63
*
64
- * @param item the last emitted item, that caused the exception wrapped in {@link OnErrorThrowable.OnNextValue}.
65
- * @return a short {@link String} representation of the item if one is known for its type, or null for default.
64
+ * @param item the last emitted item, that caused the exception wrapped in
65
+ * {@code OnErrorThrowable.OnNextValue}
66
+ * @return a short {@link String} representation of the item if one is known for its type, or null for
67
+ * default
68
+ * @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the
69
+ * release number)
66
70
*/
67
71
@ Experimental
68
72
public final String handleOnNextValueRendering (Object item ) {
@@ -80,16 +84,20 @@ public final String handleOnNextValueRendering(Object item) {
80
84
/**
81
85
* Override this method to provide rendering for specific types other than primitive types and null.
82
86
* <p>
83
- * For performance and overhead reasons, this should should limit to a safe production of a short {@code String}
84
- * (as large renderings will bloat up the stacktrace). Prefer to try/catch({@code Throwable}) all code
85
- * inside this method implementation.
87
+ * For performance and overhead reasons, this should should limit to a safe production of a short
88
+ * {@code String} (as large renderings will bloat up the stacktrace). Prefer to try/catch({@code Throwable})
89
+ * all code inside this method implementation.
86
90
* <p>
87
91
* If a {@code Throwable} is caught when rendering, this will fallback to the item's classname suffixed by
88
92
* {@value #ERROR_IN_RENDERING_SUFFIX}.
89
93
*
90
- * @param item the last emitted item, that caused the exception wrapped in {@link OnErrorThrowable.OnNextValue}.
91
- * @return a short {@link String} representation of the item if one is known for its type, or null for default.
94
+ * @param item the last emitted item, that caused the exception wrapped in
95
+ * {@code OnErrorThrowable.OnNextValue}
96
+ * @return a short {@link String} representation of the item if one is known for its type, or null for
97
+ * default
92
98
* @throws InterruptedException if the rendering thread is interrupted
99
+ * @since (if this graduates from Experimental/Beta to supported, replace this parenthetical with the
100
+ * release number)
93
101
*/
94
102
@ Experimental
95
103
protected String render (Object item ) throws InterruptedException {
0 commit comments