Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ProjectFilePersister |
|
| 1.0;1 |
1 | /* $Id: ProjectFilePersister.java 17832 2010-01-12 19:02:29Z 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 | * linus | |
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 | package org.argouml.persistence; | |
39 | ||
40 | import java.io.File; | |
41 | ||
42 | import org.argouml.kernel.Project; | |
43 | import org.argouml.taskmgmt.ProgressListener; | |
44 | ||
45 | /** | |
46 | * To persist a project to and from file storage. | |
47 | * | |
48 | * @author Bob Tarling | |
49 | */ | |
50 | public interface ProjectFilePersister { | |
51 | ||
52 | /** | |
53 | * @param project the project to save | |
54 | * @param file The file to write. | |
55 | * @throws SaveException if anything goes wrong. | |
56 | * @throws InterruptedException if the thread is interrupted | |
57 | */ | |
58 | void save(Project project, File file) throws SaveException, | |
59 | InterruptedException; | |
60 | ||
61 | /** | |
62 | * @param file the file of the project to load. | |
63 | * @return the Project | |
64 | * | |
65 | * @throws OpenException when we fail to open from this url | |
66 | * @throws InterruptedException if the thread is interrupted | |
67 | */ | |
68 | Project doLoad(File file) throws OpenException, InterruptedException; | |
69 | ||
70 | /** | |
71 | * Add any object interested in listening to persistence progress. | |
72 | * | |
73 | * @param listener the interested listener. | |
74 | */ | |
75 | public void addProgressListener(ProgressListener listener); | |
76 | ||
77 | /** | |
78 | * Remove any object no longer interested in listening to persistence | |
79 | * progress. | |
80 | * | |
81 | * @param listener the listener to remove. | |
82 | */ | |
83 | public void removeProgressListener(ProgressListener listener); | |
84 | } |