Skip to content

Commit b20543e

Browse files
committed
javadoc escaping
1 parent 788557a commit b20543e

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

src/java/org/tensorics/core/util/Maybe.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@
2727
import java.util.Optional;
2828

2929
/**
30-
* This utility class implements the concept of a "Maybe" or "Try" {@link Optional}. A Maybe<T> either carries a T or an
30+
* This utility class implements the concept of a "Maybe" or "Try" {@link Optional}. A Maybe&lt;T&gt; either carries a T or an
3131
* exception that occurred when producing it.
3232
*
3333
* @author mihostet
34-
* @param <T>
34+
* @param <T> the type to carry.
3535
*/
3636
public class Maybe<T> {
3737
private final T value;
@@ -76,8 +76,8 @@ public static <T> Maybe<T> ofValue(T value) {
7676
}
7777

7878
/**
79-
* Construct a "successful" {@link Maybe}<Void> containing a null value. This special Maybe objects represents a
80-
* successful execution with no result (e.g. a void function). Note that ONLY Maybe<Void> is allowed to carry a null
79+
* Construct a "successful" {@link Maybe}&lt;Void&gt; containing a null value. This special Maybe objects represents a
80+
* successful execution with no result (e.g. a void function). Note that ONLY Maybe&lt;Void&gt; is allowed to carry a null
8181
* value.
8282
*
8383
* @return the successful Maybe<Void> object
@@ -163,10 +163,10 @@ public static <T> Maybe<T> attempt(ThrowingSupplier<T> runnable) {
163163
}
164164

165165
/**
166-
* Construct a {@link Maybe}<Void> from the execution of a void function.
166+
* Construct a {@link Maybe}&lt;Void&gt; from the execution of a void function.
167167
*
168168
* @param runnable the function to run.
169-
* @return A successful {@link Maybe}<Void> if the function run successfully, or an exception of one occurred.
169+
* @return A successful {@link Maybe}&lt;Void&gt; if the function run successfully, or an exception of one occurred.
170170
*/
171171
public static Maybe<Void> attempt(ThrowingRunnable runnable) {
172172
requireNonNull(runnable);
@@ -201,10 +201,10 @@ public <R> Maybe<R> map(ThrowingFunction<T, R> function) {
201201
/**
202202
* Apply a void function if this {@link Maybe} is in a "successful" state. Pass through the exception in case it is
203203
* in an "unsuccessful" state. If the transformation function throws, the exception is returned wrapped in an
204-
* "unsuccessful" Maybe. If it succeeds, return an empty Maybe<Void>.
204+
* "unsuccessful" Maybe. If it succeeds, return an empty Maybe&lt;Void&gt;.
205205
*
206206
* @param function the function to apply
207-
* @return A successful Maybe<Void> if the function is executed and succeeds. An unsuccessful Maybe otherwise.
207+
* @return A successful Maybe&lt;Void&gt; if the function is executed and succeeds. An unsuccessful Maybe otherwise.
208208
*/
209209
public Maybe<Void> map(ThrowingConsumer<T> function) {
210210
requireNonNull(function);
@@ -222,7 +222,7 @@ public Maybe<Void> map(ThrowingConsumer<T> function) {
222222
/**
223223
* Apply a function if this {@link Maybe} is in a "successful" state. Pass through the exception in case it is in an
224224
* "unsuccessful" state. The function does not get the value of the Maybe passed as parameter, which is useful e.g.
225-
* for chaining Maybe<Void>. If the function succeeds, its result is returned as a successful Maybe.
225+
* for chaining Maybe&lt;Void&gt;. If the function succeeds, its result is returned as a successful Maybe.
226226
*
227227
* @param runnable the function to apply
228228
* @return A successful Maybe wrapping the return value if the function is executed and succeeds. An unsuccessful
@@ -243,10 +243,10 @@ public <R> Maybe<R> then(ThrowingSupplier<R> runnable) {
243243
/**
244244
* Apply a void function if this {@link Maybe} is in a "successful" state. Pass through the exception in case it is
245245
* in an "unsuccessful" state. The function does not get the value of the Maybe passed as parameter, which is useful
246-
* e.g. for chaining Maybe<Void>. If the function succeeds, a successful empty Maybe<Void> is returned.
246+
* e.g. for chaining Maybe&lt;Void&gt;. If the function succeeds, a successful empty Maybe&lt;Void&gt; is returned.
247247
*
248248
* @param runnable the function to apply
249-
* @return A successful Maybe<Void> it the function is executed and succeeds. An unsuccessful Maybe otherwise.
249+
* @return A successful Maybe&lt;Void&gt; it the function is executed and succeeds. An unsuccessful Maybe otherwise.
250250
*/
251251
public Maybe<Void> then(ThrowingRunnable runnable) {
252252
requireNonNull(runnable);

0 commit comments

Comments
 (0)