geode-core/src/main/java/org/apache/geode/services/result/impl/Success.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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 org.apache.geode.services.result.impl;

import java.util.function.Consumer;
import java.util.function.Function;

import org.apache.geode.annotations.Immutable;
import org.apache.geode.services.result.ServiceResult;

/**
 * This type of {@link ServiceResult} represents a successful operation. It contains the
 * return value of type {@code SuccessType}
 *
 * @param <SuccessType> the result type for a successful operation.
 *
 * @since 1.14.0
 *
 * @see ServiceResult
 * @see Failure
 */
public class Success<SuccessType> implements ServiceResult<SuccessType> {

  @Immutable
  public static final Success<Boolean> SUCCESS_TRUE = Success.of(true);

  private final SuccessType result;

  private Success(SuccessType result) {
    this.result = result;
  }

  /**
   * Creates a {@link Success} object containing the errorMessage
   *
   * @param <T> the type of the result
   * @param result the return value of the successful operation
   * @return a {@link Success} instance containing the return value
   */
  public static <T> Success<T> of(T result) {
    return new Success<>(result);
  }

  @Override
  public <T> T map(Function<SuccessType, T> successFunction, Function<String, T> errorFunction) {
    return successFunction.apply(result);
  }

  @Override
  public SuccessType getMessage() {
    return result;
  }

  @Override
  public String getErrorMessage() {
    throw new RuntimeException("This Result is not of type Failure.");
  }

  @Override
  public boolean isSuccessful() {
    return true;
  }

  @Override
  public ServiceResult<SuccessType> ifSuccessful(
      Consumer<? super SuccessType> consumer) {
    if (isSuccessful()) {
      consumer.accept(result);
    }
    return this;
  }
}