lang-api/src/com/intellij/psi/ResolveResult.java

   1 /*
   2  * Copyright 2000-2007 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;
  17
  18 import org.jetbrains.annotations.Nullable;
  19
  20 /**
  21  * Represents the result of resolving a {@link com.intellij.psi.PsiPolyVariantReference}.
  22  *
  23  * @see com.intellij.psi.PsiElementResolveResult
  24  */
  25 public interface ResolveResult {
  26   /**
  27    * The empty array of PSI resolve results which can be reused to avoid unnecessary allocations.
  28    */
  29   ResolveResult[] EMPTY_ARRAY = new ResolveResult[0];
  30
  31   /**
  32    * Returns the result of the resolve.
  33    *
  34    * @return an element the reference is resolved to.
  35    */
  36   @Nullable
  37   PsiElement getElement();
  38
  39   /**
  40    * Checks if the reference was resolved to a valid element.
  41    *
  42    * @return true if the resolve encountered no problems
  43    */
  44   boolean isValidResult();
  45 }