DocumentOperationReverser.java

/**
 * Copyright 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package org.waveprotocol.wave.model.document.operation;

import org.waveprotocol.wave.model.operation.SilentOperationSink;


/**
 * A document that can reverse whatever modifications are performed on it.
 *
 */
public interface DocumentOperationReverser extends ModifiableDocument {

  /**
   * Registers a sink into which reverse operations should be sunk.
   *
   * @param reverseSink The sink into which reverse operations should be sunk.
   */
  void registerReverseSink(SilentOperationSink<DocOp> reverseSink);

  /**
   * Unregisters the sink.
   */
  void unregisterReverseSink();

}