Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GEODE-10023: do not @link to type params #7601

Merged
merged 1 commit into from
Apr 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -30,27 +30,27 @@
@Experimental
public interface Result<SuccessType, FailureType> {
/**
* A mapping function that maps to either {@link SuccessType} or {@link FailureType} depending on
* A mapping function that maps to either {@code SuccessType} or {@code FailureType} depending on
* success or
* failure of the operation.
*
* @param successFunction the mapping function to map the SuccessType to the resultant type
* @param errorFunction the mapping function to map the FailureType to the resultant error type
* @param <T> the resultant type
* @return result of type {@link T}
* @return result of type {@code T}
*/
<T> T map(Function<SuccessType, T> successFunction,
Function<FailureType, T> errorFunction);

/**
* The return message of a successful operation. The return type is of type {@link SuccessType}
* The return message of a successful operation. The return type is of type {@code SuccessType}
*
* @return the result of the operation
*/
SuccessType getMessage();

/**
* The return message of a failed operation. The return type is of type {@link FailureType}
* The return message of a failed operation. The return type is of type {@code FailureType}
*
* @return the failure message of why the operation did not succeed.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

/**
* This type of {@link ServiceResult} represents a successful operation. It contains the
* return value of type {@link SuccessType}
* return value of type {@code SuccessType}
*
* @param <SuccessType> the result type for a successful operation.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public ClusterManagementOperationResult() {}
/**
* normally called by {@link ClusterManagementService#start(ClusterManagementOperation)}
*
* @param statusCode the {@link StatusCode} of the result
* @param statusCode the {@code StatusCode} of the result
* @param message the status message to set
* @param operationStart a {@link Date} representing the time the operation started
* @param operationEnd a {@link Date} representing the time the operation ended
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public ClusterManagementRealizationResult() {}
/**
* for internal use only
*
* @param statusCode the {@link StatusCode} to set
* @param statusCode the {@code StatusCode} to set
* @param message the status message to set
*/
public ClusterManagementRealizationResult(StatusCode statusCode, String message) {
Expand Down