/**
* 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.document.operation;
import org.waveprotocol.wave.model.document.operation.impl.AttributesImpl;
import org.waveprotocol.wave.model.document.operation.util.StateMap;
/**
* A set of attributes, implemented as a map from attribute names to attribute
* values. The attributes in the map are sorted by their names, so that the set
* obtained from entrySet() will allow you to easily iterate through the
* attributes in sorted order.
*
* Implementations must be immutable.
*/
public interface Attributes extends StateMap {
public static final AttributesImpl EMPTY_MAP = new AttributesImpl();
public Attributes updateWith(AttributesUpdate mutation);
/**
* Same as {@link #updateWith(AttributesUpdate)}, but the mutation does
* not have to be compatible. This is useful when the mutation may
* already be known to be incompatible, but we wish still to perform it.
*
* This is useful for validity checking code, for example. In general,
* {@link #updateWith(AttributesUpdate)} should be used instead.
*
* @param mutation does not have to be compatible
* @return a new updated map, based on the key to new-value pairs, ignoring
* the old values.
*/
public Attributes updateWithNoCompatibilityCheck(AttributesUpdate mutation);
}