platform/refactoring/src/com/intellij/refactoring/rename/RenameInputValidatorEx.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

// Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.refactoring.rename;

import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.NlsContexts.DialogMessage;
import com.intellij.psi.PsiElement;
import com.intellij.util.ProcessingContext;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * Adds ability to provide custom error message.
 */
public interface RenameInputValidatorEx extends RenameInputValidator {

  /**
   * Called only if all input validators ({@link RenameInputValidator}) accept
   * the new name in {@link #isInputValid(String, PsiElement, ProcessingContext)}
   * and name is a valid identifier for the language of the element.
   *
   * @return {@code null} if newName is a valid name, custom error message otherwise
   */
  @Nullable
  @DialogMessage String getErrorMessage(@NotNull String newName, @NotNull Project project);
}