de.tsl2.nano.incubation.repeat.IMacroManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tsl2.nano.repeatable Show documentation

TSL2 Framework Repeatable (generic Undo/Redo and Macro mechanism)

There is a newer version: 2.5.1

/*
 * File: $HeadURL$
 * Id  : $Id$
 * 
 * created by: Tom, Thomas Schneider
 * created on: 21.11.2014
 * 
 * Copyright: (c) Thomas Schneider 2014, all rights reserved
 */
package de.tsl2.nano.incubation.repeat;

/**
 * simple macro manager definition
 * 
 * @author Tom, Thomas Schneider
 * @version $Revision$
 */
public interface IMacroManager {
    /**
     * @param id macro identifier to be used later for {@link #play(String, Object)}. to start recording, the id must
     *            not be null! internally, the invoking will be done without an id (=null) - using the id from first
     *            call.
     * @param macros one or more macro to record.
     */
    void record(String id, ICommand... macros);

    /**
     * @return true, if {@link #record(String)} was called and {@link #stop()} was not called yet after.
     */
    boolean isRecording();

    /**
     * stops the current recording. can only be called, if {@link #record(String, ICommand...)} was called before
     * 
     * @return count of recorded items
     */
    int stop();

    /**
     * @param context context to do the play() on
     * @return count of items changed.
     */
    int play(String id, CONTEXT context);
}