File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\model\Saveable.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.model;
25
26 import hudson.BulkChange;
27 import hudson.model.listeners.SaveableListener;
28 import java.io.IOException;
29
30 /**
31 * Object whose state is persisted to XML.
32 *
33 * @author Kohsuke Kawaguchi
34 * @see BulkChange
35 * @since 1.249
36 */
37 public interface Saveable {
38 /**
39 * Persists the state of this object into XML.
40 *
41 * <p>
42 * For making a bulk change efficiently, see {@link BulkChange}.
43 *
44 * <p>
45 * To support listeners monitoring changes to this object, call {@link SaveableListener.fireOnChange}
46 * @throws IOException
47 * if the persistence failed.
48 */
49 void save() throws IOException;
50
51 /**
52 * {@link Saveable} that doesn't save anything.
53 * @since 1.301.
54 */
55 Saveable NOOP = new Saveable() {
56 public void save() throws IOException {
57 }
58 };
59 }
60