1 /*
2 * XNap Commons
3 *
4 * Copyright (C) 2005 Steffen Pingel
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20 package org.xnap.commons.io;
21
22 /***
23 * Defines the requirements for tasks that run asynchronously and need to
24 * provide user interaction through a
25 * {@link org.xnap.commons.io.ProgressMonitor}.
26 *
27 * @author Steffen Pingel
28 */
29 public interface Job<T> {
30
31 /***
32 * Carries out a task thereby notifying the <code>monitor</code> of its
33 * current progress.
34 *
35 * @return the result of the operation
36 * @throws Exception
37 */
38 T run(ProgressMonitor monitor) throws Exception;
39
40 }