alluxio.shaded.client.net.jodah.failsafe.event.ExecutionScheduledEvent Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in alluxio.shaded.client.com.liance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.alluxio.shaded.client.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 alluxio.shaded.client.net.jodah.failsafe.event;

import alluxio.shaded.client.net.jodah.failsafe.ExecutionContext;

import java.time.Duration;

/**
 * Indicates an execution was scheduled. A scheduled execution will be executed after the {@link #getDelay() delay}
 * unless it is cancelled, either explicitly or via {@link java.util.concurrent.Future#cancel(boolean)
 * Future.cancel(boolean)}, a {@link alluxio.shaded.client.net.jodah.failsafe.Timeout Timeout}, or if the underlying {@link
 * alluxio.shaded.client.net.jodah.failsafe.util.concurrent.Scheduler Scheduler} or {@link java.util.concurrent.ExecutorService
 * ExecutorService} is shutdown.
 *
 * @param  result type
 * @author Jonathan Halterman
 */
public class ExecutionScheduledEvent extends ExecutionEvent {
  private final R result;
  private final Throwable failure;
  private final Duration delay;

  public ExecutionScheduledEvent(R result, Throwable failure, Duration delay, ExecutionContext context) {
    super(context);
    this.result = result;
    this.failure = failure;
    this.delay = delay;
  }

  /**
   * Returns the failure that preceded the event, else {@code null} if there was none.
   */
  public Throwable getLastFailure() {
    return failure;
  }

  /**
   * Returns the result that preceded the event, else {@code null} if there was none.
   */
  public R getLastResult() {
    return result;
  }

  /**
   * Returns the delay before the next execution attempt.
   */
  public Duration getDelay() {
    return delay;
  }

  @Override
  public String toString() {
    return "ExecutionScheduledEvent[" + "result=" + result + ", failure=" + failure + ", delay=" + delay + ']';
  }
}