| package org.apache.helix.task; |
| |
| /* |
| * 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. |
| */ |
| |
| /** |
| * The result of a task execution. |
| */ |
| public class TaskResult { |
| /** |
| * An enumeration of status codes. |
| */ |
| public enum Status { |
| /** The task completed normally. */ |
| COMPLETED, |
| /** |
| * The task was cancelled externally, i.e. {@link org.apache.helix.task.Task#cancel()} was |
| * called. |
| */ |
| CANCELED, |
| /** The task encountered an error from which it can not recover. |
| * This is equivalent to {@link org.apache.helix.task.TaskResult.Status#FAILED}.*/ |
| @Deprecated |
| ERROR, |
| /** The task encountered an error which can not be recovered from this run, but it may still succeed by retrying the task. */ |
| FAILED, |
| /** The task encountered an error, which will not be recoverable even with retrying the task */ |
| FATAL_FAILED |
| } |
| |
| private final Status _status; |
| private final String _info; |
| |
| /** |
| * Constructs a new {@link TaskResult}. |
| * @param status The status code. |
| * @param info Information that can be interpreted by the {@link Task} implementation that |
| * constructed this object. |
| * May encode progress or check point information that can be used by the task to resume |
| * from where it |
| * left off in a previous execution. |
| */ |
| public TaskResult(Status status, String info) { |
| _status = status; |
| _info = info; |
| } |
| |
| public Status getStatus() { |
| return _status; |
| } |
| |
| public String getInfo() { |
| return _info; |
| } |
| |
| @Override |
| public String toString() { |
| return "TaskResult{" + "_status=" + _status + ", _info='" + _info + '\'' + '}'; |
| } |
| } |