| 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 interface that is to be implemented by a specific task implementation. |
| */ |
| public interface Task { |
| /** |
| * Execute the task. |
| * @return A {@link TaskResult} object indicating the status of the task and any additional |
| * context |
| * information that |
| * can be interpreted by the specific {@link Task} implementation. |
| */ |
| TaskResult run(); |
| |
| /** |
| * Signals the task to stop execution. The task implementation should carry out any clean up |
| * actions that may be |
| * required and return from the {@link #run()} method. |
| */ |
| void cancel(); |
| } |