001    /**
002     * ===========================================
003     * LibLayout : a free Java layouting library
004     * ===========================================
005     *
006     * Project Info:  http://reporting.pentaho.org/liblayout/
007     *
008     * (C) Copyright 2006-2007, by Pentaho Corporation and Contributors.
009     *
010     * This library is free software; you can redistribute it and/or modify it under the terms
011     * of the GNU Lesser General Public License as published by the Free Software Foundation;
012     * either version 2.1 of the License, or (at your option) any later version.
013     *
014     * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
015     * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016     * See the GNU Lesser General Public License for more details.
017     *
018     * You should have received a copy of the GNU Lesser General Public License along with this
019     * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
020     * Boston, MA 02111-1307, USA.
021     *
022     * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
023     * in the United States and other countries.]
024     *
025     * ------------
026     * $Id: State.java 3044 2007-07-28 17:52:44Z tmorgner $
027     * ------------
028     * (C) Copyright 2006-2007, by Pentaho Corporation.
029     */
030    package org.jfree.layouting;
031    
032    import java.io.Serializable;
033    
034    /**
035     * As it is said. Its a state. A state object is created by a StatefullComponent
036     * and is used to save and restore the state of that component. The state object
037     * must be immutable - and the restore methods must make sure that the state
038     * object's contents are not modified in any way.
039     *
040     * @author Thomas Morgner
041     */
042    public interface State extends Serializable
043    {
044      /**
045       * Creates a restored instance of the saved component.
046       *
047       * By using this factory-like approach, we gain independence from having to
048       * know the actual implementation. This makes things a lot easier.
049       *
050       * @param layoutProcess the layout process that controls it all
051       * @return the saved state
052       * @throws StateException
053       */
054      public StatefullComponent restore (LayoutProcess layoutProcess) throws StateException;
055    }