/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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;
/**
* A <code>DocOpCursor</code> that can return a value at the end of a sequence
* of operation components.
*
* @param <T> the type of the value returned by an instance of this interface
*/
public interface EvaluatingDocOpCursor<T> extends DocOpCursor {
/**
* Signals the completion of the sequence of mutation events and returns a
* value.
*
* @return a value returned after all the mutation events have been applied.
*/
T finish();
}