Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ProgressEvent |
|
| 1.0;1 |
1 | /* $Id: ProgressEvent.java 17840 2010-01-12 19:09:10Z linus $ | |
2 | ***************************************************************************** | |
3 | * Copyright (c) 2009 Contributors - see below | |
4 | * All rights reserved. This program and the accompanying materials | |
5 | * are made available under the terms of the Eclipse Public License v1.0 | |
6 | * which accompanies this distribution, and is available at | |
7 | * http://www.eclipse.org/legal/epl-v10.html | |
8 | * | |
9 | * Contributors: | |
10 | * mvw | |
11 | ***************************************************************************** | |
12 | * | |
13 | * Some portions of this file was previously release using the BSD License: | |
14 | */ | |
15 | ||
16 | // Copyright (c) 1996-2007 The Regents of the University of California. All | |
17 | // Rights Reserved. Permission to use, copy, modify, and distribute this | |
18 | // software and its documentation without fee, and without a written | |
19 | // agreement is hereby granted, provided that the above copyright notice | |
20 | // and this paragraph appear in all copies. This software program and | |
21 | // documentation are copyrighted by The Regents of the University of | |
22 | // California. The software program and documentation are supplied "AS | |
23 | // IS", without any accompanying services from The Regents. The Regents | |
24 | // does not warrant that the operation of the program will be | |
25 | // uninterrupted or error-free. The end-user understands that the program | |
26 | // was developed for research purposes and is advised not to rely | |
27 | // exclusively on the program for any reason. IN NO EVENT SHALL THE | |
28 | // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, | |
29 | // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, | |
30 | // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF | |
31 | // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF | |
32 | // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY | |
33 | // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | |
34 | // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE | |
35 | // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF | |
36 | // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, | |
37 | // UPDATES, ENHANCEMENTS, OR MODIFICATIONS. | |
38 | ||
39 | package org.argouml.taskmgmt; | |
40 | ||
41 | import java.util.EventObject; | |
42 | ||
43 | /** | |
44 | * An event to be fired in order to tell some other listener of progress | |
45 | * through some activity. | |
46 | * | |
47 | * @author Bob Tarling | |
48 | */ | |
49 | public class ProgressEvent extends EventObject { | |
50 | ||
51 | private long length; | |
52 | ||
53 | private long position; | |
54 | ||
55 | /** | |
56 | * Constructor for a new ProgressEvent. | |
57 | * | |
58 | * @param source the source that generated this event | |
59 | * @param thePosition the position to which progress has reach as a | |
60 | * proportion of length | |
61 | * @param theLength the total length the progress is measuring | |
62 | */ | |
63 | public ProgressEvent(Object source, long thePosition, long theLength) { | |
64 | 0 | super(source); |
65 | 0 | this.length = theLength; |
66 | 0 | this.position = thePosition; |
67 | 0 | } |
68 | ||
69 | /** | |
70 | * Return the position of progress as a proportion of length. | |
71 | * @return progress position. | |
72 | */ | |
73 | public long getPosition() { | |
74 | 0 | return position; |
75 | } | |
76 | ||
77 | /** | |
78 | * Return the length that progress is measuring. Typically this is the | |
79 | * length of a file or 100 if percentage progress is being measured. | |
80 | * @return progress length. | |
81 | */ | |
82 | public long getLength() { | |
83 | 0 | return length; |
84 | } | |
85 | ||
86 | /** | |
87 | * The UID. | |
88 | */ | |
89 | private static final long serialVersionUID = -440923505939663713L; | |
90 | } |