StubModifiableAnnotations.java

/**
 * 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.indexed;

import org.waveprotocol.wave.model.document.AnnotationCursor;
import org.waveprotocol.wave.model.document.AnnotationInterval;
import org.waveprotocol.wave.model.document.RangedAnnotation;
import org.waveprotocol.wave.model.document.util.GenericAnnotationCursor;
import org.waveprotocol.wave.model.document.util.GenericAnnotationIntervalIterable;
import org.waveprotocol.wave.model.document.util.GenericRangedAnnotationIterable;
import org.waveprotocol.wave.model.util.CollectionUtils;
import org.waveprotocol.wave.model.util.ReadableStringMap;
import org.waveprotocol.wave.model.util.ReadableStringSet;

/**
 * Blank implementation for when we want to ignore annotations.
 *
 * The implementation does keep track of size, and enforces many constraints.
 *
 * @author danilatos@google.com (Daniel Danilatos)
 */
public class StubModifiableAnnotations<V> implements RawAnnotationSet<V> {

  private int size = 0;

  private boolean modifying = false;

  @Override
  public int size() {
    return size;
  }

  @Override
  public void begin() {
    assert !modifying : "Can't make nested modification";
    modifying = true;
  }

  @Override
  public void finish() {
    assert modifying : "Can't finish non existent modification";
    modifying = false;
  }

  @Override
  public void delete(int deleteSize) {
    assert modifying : "Can't make change unless during modification";
    size -= deleteSize;
  }

  @Override
  public void endAnnotation(String key) {
    assert modifying : "Can't make change unless during modification";
  }

  @Override
  public void insert(int insertSize) {
    assert modifying : "Can't make change unless during modification";
    size += insertSize;
  }

  @Override
  public void skip(int skipSize) {
    assert modifying : "Can't make change unless during modification";
  }

  @Override
  public void startAnnotation(String key, V value) {
    assert modifying : "Can't make change unless during modification";
  }

  @Override
  public V getAnnotation(int start, String key) {
    return null;
  }

  @Override
  public int firstAnnotationChange(int start, int end, String key, V fromValue) {
    return -1;
  }

  @Override
  public int lastAnnotationChange(int start, int end, String key, V fromValue) {
    return -1;
  }

  @Override
  public AnnotationCursor annotationCursor(int start, int end, ReadableStringSet keys) {
    if (keys == null) {
      keys = CollectionUtils.createStringSet();
    }
    return new GenericAnnotationCursor<V>(this, start, end, keys);
  }

  @Override
  public void forEachAnnotationAt(int location, ReadableStringMap.ProcV<V> callback) {
    // don't call callback, no annotations
  }

  @Override
  public Iterable<AnnotationInterval<V>> annotationIntervals(int start, int end,
      ReadableStringSet keys) {
    if (keys == null) {
      keys = CollectionUtils.createStringSet();
    }
    return new GenericAnnotationIntervalIterable<V>(this, start, end, keys);
  }

  @Override
  public Iterable<RangedAnnotation<V>> rangedAnnotations(int start, int end,
      ReadableStringSet keys) {
    if (keys == null) {
      keys = CollectionUtils.createStringSet();
    }
    return new GenericRangedAnnotationIterable<V>(this, start, end, keys);
  }

  @Override
  public String getInherited(String key) {
    return null;
  }

  @Override
  public ReadableStringSet knownKeys() {
    return CollectionUtils.createStringSet();
  }

  @Override
  public ReadableStringSet knownKeysLive() {
    return CollectionUtils.createStringSet();
  }
}