01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU General
07: * Public License Version 2 only ("GPL") or the Common Development and Distribution
08: * License("CDDL") (collectively, the "License"). You may not use this file except in
09: * compliance with the License. You can obtain a copy of the License at
10: * http://www.netbeans.org/cddl-gplv2.html or nbbuild/licenses/CDDL-GPL-2-CP. See the
11: * License for the specific language governing permissions and limitations under the
12: * License. When distributing the software, include this License Header Notice in
13: * each file and include the License file at nbbuild/licenses/CDDL-GPL-2-CP. Sun
14: * designates this particular file as subject to the "Classpath" exception as
15: * provided by Sun in the GPL Version 2 section of the License file that
16: * accompanied this code. If applicable, add the following below the License Header,
17: * with the fields enclosed by brackets [] replaced by your own identifying
18: * information: "Portions Copyrighted [year] [name of copyright owner]"
19: *
20: * Contributor(s):
21: *
22: * The Original Software is NetBeans. The Initial Developer of the Original Software
23: * is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun Microsystems, Inc. All
24: * Rights Reserved.
25: *
26: * If you wish your version of this file to be governed by only the CDDL or only the
27: * GPL Version 2, indicate your decision by adding "[Contributor] elects to include
28: * this software in this distribution under the [CDDL or GPL Version 2] license." If
29: * you do not indicate a single choice of license, a recipient has the option to
30: * distribute your version of this file under either the CDDL, the GPL Version 2 or
31: * to extend the choice of license to its licensees as provided above. However, if
32: * you add GPL Version 2 code and therefore, elected the GPL Version 2 license, then
33: * the option applies only if the new code is made subject to such option by the
34: * copyright holder.
35: */
36:
37: package org.netbeans.installer.utils.progress;
38:
39: /**
40: * The interface which needs to be implemented by classes which need to listen to
41: * a progress' state change events.
42: *
43: * <p>
44: * They will need to register themselves with the progress object by either
45: * constructing the progress with a specialized constructor or calling the
46: * {@link Progress#addProgressListener(ProgressListener)} method.
47: *
48: * @see Progress#Progress(ProgressListener)
49: * @see Progress#addProgressListener(ProgressListener)
50: *
51: * @author Kirill Sorokin
52: *
53: * @since 1.0
54: */
55: public interface ProgressListener {
56: /**
57: * This method will be called when a {@link Progress} being listened changes
58: * its state.
59: *
60: * <p>
61: * The actual {@link Progress} which has changed will be passed in as the only
62: * parameter. A progress' state is considered changed when any of its core
63: * properties (<code>title</code>, <code>detail</code>, <code>percentage</code>,
64: * <code>canceled</code>) change.
65: *
66: * @param progress The {@link Progress} whose state has changed.
67: */
68: void progressUpdated(final Progress progress);
69: }
|