Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.driver.evaluator;
020
021import org.apache.reef.annotations.Provided;
022import org.apache.reef.annotations.audience.DriverSide;
023import org.apache.reef.annotations.audience.Public;
024import org.apache.reef.driver.context.FailedContext;
025import org.apache.reef.driver.task.FailedTask;
026import org.apache.reef.exception.EvaluatorException;
027import org.apache.reef.io.naming.Identifiable;
028import org.apache.reef.util.Optional;
029
030import java.util.List;
031
032/**
033 * Represents an Evaluator that became unavailable.
034 */
035@DriverSide
036@Public
037@Provided
038public interface FailedEvaluator extends Identifiable {
039
040  /**
041   * @return the reason for the failure.
042   */
043  EvaluatorException getEvaluatorException();
044
045  /**
046   * @return the list of all context that failed due to the evaluator failure.
047   */
048  List<FailedContext> getFailedContextList();
049
050  /**
051   * @return the failed task, if there was one running at the time of the evaluator failure.
052   */
053  Optional<FailedTask> getFailedTask();
054
055}