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 @ 47839
History | View | Annotate | Download (2.08 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 |
package org.gvsig.compat.net; |
| 25 |
|
| 26 |
/**
|
| 27 |
* <p>
|
| 28 |
* When a task is accessing to remote data, takes an indeterminate time, and
|
| 29 |
* occasionally gets locked. That's the reason a task should support to be
|
| 30 |
* cancelable.</p>
|
| 31 |
* <p>
|
| 32 |
* <code>ICancellable</code> interface is designed for getting information about
|
| 33 |
* the cancellation of a task of downloading remote information.</p>
|
| 34 |
*/
|
| 35 |
public interface ICancellable { |
| 36 |
|
| 37 |
public static final ICancellable DUMB = new ICancellable() { |
| 38 |
@Override
|
| 39 |
public boolean isCanceled() { |
| 40 |
return false; |
| 41 |
} |
| 42 |
|
| 43 |
@Override
|
| 44 |
public Object getID() { |
| 45 |
return ICancellable.class.getName();
|
| 46 |
} |
| 47 |
}; |
| 48 |
|
| 49 |
/**
|
| 50 |
* <p>
|
| 51 |
* Returns <code>true</code> if a download or a group of downloads tasks has
|
| 52 |
* been canceled.</p>
|
| 53 |
*
|
| 54 |
* @return <code>true</code> if a download or a group of downloads tasks has
|
| 55 |
* been canceled, otherwise <code>false</code>
|
| 56 |
*/
|
| 57 |
public boolean isCanceled(); |
| 58 |
|
| 59 |
/**
|
| 60 |
* <p>
|
| 61 |
* Used to cancel only a group of downloads tasks with the same
|
| 62 |
* identifier.</p>
|
| 63 |
*
|
| 64 |
* @return the identifier
|
| 65 |
*/
|
| 66 |
public Object getID(); |
| 67 |
} |