1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
// Copyright (C) 2001-2003 Jon A. Maxwell (JAM)
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
package net.sourceforge.jnlp.cache;
import java.net.*;
import javax.jnlp.*;
import net.sourceforge.jnlp.runtime.*;
/**
* A DownloadIndicator creates DownloadServiceListeners that are
* notified of resources being transferred and their progress.
*
* @author <a href="mailto:jmaxwell@users.sourceforge.net">Jon A. Maxwell (JAM)</a> - initial author
* @version $Revision: 1.8 $
*/
public interface DownloadIndicator {
/**
* Return a download service listener that displays the progress
* of downloading resources. Update messages may be reported
* for URLs that are not included initially.<p>
*
* Progress messages are sent as if the DownloadServiceListener
* were listening to a DownloadService request. The listener
* will receive progress messages from time to time during the
* download. <p>
*
* @param app JNLP application downloading the files, or null if not applicable
* @param downloadName name identifying the download to the user
* @param resources initial urls to display, empty if none known at start
*/
public DownloadServiceListener getListener(ApplicationInstance app,
String downloadName,
URL resources[]);
/**
* Indicates that a download service listener that was obtained
* from the getDownloadListener method will no longer be used.
* This method can be used to ensure that progress dialogs are
* properly removed once a particular download is finished.
*
* @param listener the listener that is no longer in use
*/
public void disposeListener(DownloadServiceListener listener);
/**
* Return the desired time in milliseconds between updates.
* Updates are not guarenteed to occur based on this value; for
* example, they may occur based on the download percent or some
* other factor.
*
* @return rate in milliseconds, must be >= 0
*/
public int getUpdateRate();
/**
* Return a time in milliseconds to wait for a download to
* complete before obtaining a listener for the download. This
* value can be used to skip lengthy operations, such as
* initializing a GUI, for downloads that complete quickly. The
* getListener method is not called if the download completes
* in less time than the returned delay.
*
* @return delay in milliseconds, must be >= 0
*/
public int getInitialDelay();
}
|
