Ptidej-v5.2-master/POM Tests/data/ArgoUML_0.28/src/org/argouml/model/ModelMemento.java
// $Id: ModelMemento.java 13454 2007-08-28 19:48:30Z bobtarling $
// Copyright (c) 2004-2006 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.model;

/**
 * A memento to record the state of an object before an undoable change.<p>
 * The model implementation should create a ModelMemento for any
 * undoable operation performed. Any mutator method should normally be
 * undoable except loading a model from file.
 * 
 * @author Bob Tarling
 */
public abstract class ModelMemento {

    /**
     * The method to undo this memento.
     */
    public abstract void undo();

    /**
     * The method to redo this memento once undone.
     */
    public abstract void redo();
    
    /**
     * Dispose of any resources used by this memento before it is
     * destroyed. A memento is destroyed when it is forced off the
     * end of the undo or redo stack when that stack has reached
     * its maximum size or when the stack is emptied.
     */
    public void dispose() {
    }
}
