Statistics
| Revision:

svn-gvsig-desktop / trunk / org.gvsig.desktop / org.gvsig.desktop.compat.cdc / org.gvsig.compat / org.gvsig.compat.api / src / main / java / org / gvsig / compat / net / ICancellable.java @ 40559

History | View | Annotate | Download (1.9 KB)

1
/**
2
 * gvSIG. Desktop Geographic Information System.
3
 *
4
 * Copyright (C) 2007-2013 gvSIG Association.
5
 *
6
 * This program is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU General Public License
8
 * as published by the Free Software Foundation; either version 3
9
 * of the License, or (at your option) any later version.
10
 *
11
 * This program 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
14
 * GNU General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU General Public License
17
 * along with this program; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19
 * MA  02110-1301, USA.
20
 *
21
 * For any additional information, do not hesitate to contact us
22
 * at info AT gvsig.com, or visit our website www.gvsig.com.
23
 */
24
/* CVS MESSAGES:
25
 *
26
 * $Id: ICancellable.java 29658 2009-06-29 17:10:19Z jpiera $
27
 * $Log$
28
 * Revision 1.1  2006-05-24 16:37:34  jaume
29
 * *** empty log message ***
30
 *
31
 *
32
 */
33
package org.gvsig.compat.net;
34

    
35
/**
36
 * <p>When a task is accessing to remote data, takes an indeterminate time, and occasionally gets locked. That's
37
 * the reason a task should support to be cancelable.</p>
38
 * <p><code>ICancellable</code> interface is designed for getting information about the cancellation of a
39
 * task of downloading remote information.</p>
40
 */
41
public interface ICancellable {
42
        /**
43
         * <p>Returns <code>true</code> if a download or a group of downloads tasks has been canceled.</p>
44
         * 
45
         * @return <code>true</code> if a download or a group of downloads tasks has been canceled, otherwise <code>false</code>
46
         */
47
        public boolean isCanceled();
48
        
49
        /**
50
         * <p>Used to cancel only a group of downloads tasks with the same identifier.</p>
51
         * 
52
         * @return the identifier
53
         */
54
        public Object getID();
55
}