MatchResult.java

package com.intellij.structuralsearch;

import com.intellij.psi.PsiElement;
import com.intellij.structuralsearch.plugin.util.SmartPsiPointer;
import org.jetbrains.annotations.NonNls;

import java.util.List;

/**
 * Class describing the match result
 */
public abstract class MatchResult {
  @NonNls public static final String LINE_MATCH = "__line__";
  @NonNls public static final String MULTI_LINE_MATCH = "__multi_line__";

  public abstract String getMatchImage();

  public abstract SmartPsiPointer getMatchRef();
  public abstract PsiElement getMatch();
  public abstract int getStart();
  public abstract int getEnd();

  public abstract String getName();

  public abstract List<MatchResult> getAllSons();
  public abstract boolean hasSons();
  public abstract boolean isScopeMatch();
  public abstract boolean isMultipleMatch();
  public abstract boolean isTarget();
}