platform/lang-api/src/com/intellij/psi/util/PsiModificationTracker.java

   1 /*
   2  * Copyright 2000-2009 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.intellij.psi.util;
  17
  18 import com.intellij.openapi.util.Key;
  19 import com.intellij.openapi.util.ModificationTracker;
  20
  21 public interface PsiModificationTracker extends ModificationTracker {
  22
  23   /**
  24    * This key can be passed as a dependency in a {@link com.intellij.psi.util.CachedValueProvider}.
  25    * @see #getModificationCount()
  26    */
  27   Key MODIFICATION_COUNT = Key.create("MODIFICATION_COUNT");
  28
  29   /**
  30    * This key can be passed as a dependency in a {@link com.intellij.psi.util.CachedValueProvider}.
  31    * @see #getOutOfCodeBlockModificationCount()
  32    */
  33   Key OUT_OF_CODE_BLOCK_MODIFICATION_COUNT = Key.create("OUT_OF_CODE_BLOCK_MODIFICATION_COUNT");
  34
  35   /**
  36    * This key can be passed as a dependency in a {@link com.intellij.psi.util.CachedValueProvider}.
  37    * @see #getJavaStructureModificationCount()
  38    */
  39   Key JAVA_STRUCTURE_MODIFICATION_COUNT = Key.create("JAVA_STRUCTURE_MODIFICATION_COUNT");
  40
  41   /**
  42    * Tracks any PSI modification.
  43    * @return current counter value.
  44    */
  45   long getModificationCount();
  46
  47   long getOutOfCodeBlockModificationCount();
  48
  49   long getJavaStructureModificationCount();
  50
  51   /**
  52    * Tracks modifications in Java annotations and annotated classes and methods.
  53    * @return current counter value.
  54    */
  55   long getAnnotationModificationCount();
  56
  57   interface Listener {
  58     void modificationCountChanged();
  59   }
  60 }