hudson.model.Saveable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hudson-core Show documentation

Contains the core Hudson code and view files to render HTML.

The newest version!

/*******************************************************************************
 *
 * Copyright (c) 2004-2009 Oracle Corporation.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * 
 *    Kohsuke Kawaguchi
 *
 *
 *******************************************************************************/ 

package hudson.model;

import java.io.IOException;

/**
 * Object whose state is persisted to XML.
 *
 * @author Kohsuke Kawaguchi
 * @see hudson.BulkChange
 * @since 1.249
 */
public interface Saveable {

    /**
     * Persists the state of this object into XML.
     *
     *  For making a bulk change efficiently, see {@link hudson.BulkChange}.
     *
     *  To support listeners monitoring changes to this object, call
     * {@link hudson.model.listeners.SaveableListener#fireOnChange(Saveable, hudson.XmlFile)}
     *
     * @throws IOException if the persistence failed.
     */
    void save() throws IOException;
    /**
     * {@link Saveable} that doesn't save anything.
     *
     * @since 1.301.
     */
    Saveable NOOP = new Saveable() {
        public void save() throws IOException {
        }
    };
}