comparison src/org/tmatesoft/hg/util/ProgressSupport.java @ 148:1a7a9a20e1f9

Exceptions, javadoc. Initial cancel and progress support
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Wed, 23 Feb 2011 22:36:28 +0100
parents
children d5268ca7715b
comparison
equal deleted inserted replaced
147:a05145db4d0c 148:1a7a9a20e1f9
1 /*
2 * Copyright (c) 2011 TMate Software Ltd
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; version 2 of the License.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * For information on how to redistribute this software under
14 * the terms of a license other than GNU General Public License
15 * contact TMate Software at support@hg4j.com
16 */
17 package org.tmatesoft.hg.util;
18
19 /**
20 * Mix-in to report progress of a long-running operation
21 *
22 * @author Artem Tikhomirov
23 * @author TMate Software Ltd.
24 */
25 public interface ProgressSupport {
26
27 public void start(int totalUnits);
28 public void worked(int units);
29 public void done();
30
31 static class Factory {
32
33 /**
34 * @param target object that might be capable to report progress. Can be <code>null</code>
35 * @return support object extracted from target or an empty, no-op implementation
36 */
37 public static ProgressSupport get(Object target) {
38 if (target instanceof ProgressSupport) {
39 return (ProgressSupport) target;
40 }
41 if (target instanceof Adaptable) {
42 ProgressSupport ps = ((Adaptable) target).getAdapter(ProgressSupport.class);
43 if (ps != null) {
44 return ps;
45 }
46 }
47 return new ProgressSupport() {
48 public void start(int totalUnits) {
49 }
50 public void worked(int units) {
51 }
52 public void done() {
53 }
54 };
55 }
56 }
57 }