Eclipse Platform
Release 3.1

org.eclipse.core.commands.operations
Class OperationHistoryFactory

java.lang.Object
  extended byorg.eclipse.core.commands.operations.OperationHistoryFactory

public final class OperationHistoryFactory
extends Object

This class is used to maintain the instance of the operation history that should be used by classes that access the undo or redo history and add undoable operations to the history.

It is intended that an application can create an operation history appropriate for its needs and set it into this class. Otherwise, a default operation history will be created. The operation history may only be set one time. All classes that access an operations history use this class to obtain the correct instance.

Since:
3.1

Method Summary
static IOperationHistory getOperationHistory()
          Return the operation history to be used for managing undoable operations.
static void setOperationHistory(IOperationHistory history)
          Set the operation history to be used for managing undoable operations.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getOperationHistory

public static IOperationHistory getOperationHistory()
Return the operation history to be used for managing undoable operations.

Returns:
the operation history to be used for executing, undoing, and redoing operations.

setOperationHistory

public static void setOperationHistory(IOperationHistory history)
Set the operation history to be used for managing undoable operations. This method may only be called one time, and must be called before any request to get the history. Attempts to set the operation history will be ignored after it has been already set, or after a default one has been created.

Parameters:
history - the operation history to be used for executing, undoing, and redoing operations.

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.