platform/lang-api/src/com/intellij/usageView/UsageViewDescriptor.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.usageView;
  17
  18 import com.intellij.psi.PsiElement;
  19 import org.jetbrains.annotations.NotNull;
  20
  21 public interface UsageViewDescriptor {
  22   /**
  23    * @return an array of elements whose usages were searched or {@link com.intellij.psi.PsiElement#EMPTY_ARRAY} if not available
  24    */
  25   @NotNull
  26   PsiElement[] getElements();
  27
  28   String getProcessedElementsHeader();
  29
  30   String getCodeReferencesText(int usagesCount, int filesCount);
  31
  32   String getCommentReferencesText(int usagesCount, int filesCount);
  33 }