/**
* Copyright 2009 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.util;
/**
* A typeclass-style interface for manipulating mutable data
*
* @author danilatos@google.com (Daniel Danilatos)
*
* @param <T> The data type (e.g. StringSet)
* @param <R> A read-only version of the data type (e.g. ReadableStringSet).
* If none is available, then this may be the same as <T>.
*/
public interface DataDomain<R, T extends R> {
/**
* @return a new empty instance of the data
*/
T empty();
/**
* Updates {@code target} to be the result of combining {@code changes} onto
* {@code base}
*
* @param target
* @param changes
* @param base
*/
void compose(T target, R changes, R base);
/**
* @param modifiable
* @return optionally a read-only view of the modifiable data, to provide
* runtime readonly guarantees. Otherwise just return the parameter.
*/
R readOnlyView(T modifiable);
}