From 24900db474f2f8c964f4281cd4ce0e87c02bff47 Mon Sep 17 00:00:00 2001 From: Marat Dinmukhametov Date: Mon, 17 Jun 2024 14:52:38 +0300 Subject: [PATCH] [microservices] IDEA-353802 Added documentation GitOrigin-RevId: 2562ba8b8d80860dc0718edff65f20e9766b1ae7 --- .../codeInsight/runner/JavaMainMethodProvider.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/java/java-psi-api/src/com/intellij/codeInsight/runner/JavaMainMethodProvider.java b/java/java-psi-api/src/com/intellij/codeInsight/runner/JavaMainMethodProvider.java index a765d7fc03dc..a1b3caf875d3 100644 --- a/java/java-psi-api/src/com/intellij/codeInsight/runner/JavaMainMethodProvider.java +++ b/java/java-psi-api/src/com/intellij/codeInsight/runner/JavaMainMethodProvider.java @@ -50,11 +50,19 @@ public interface JavaMainMethodProvider extends PossiblyDumbAware { @Contract(pure = true) @Nullable PsiMethod findMainInClass(@NotNull PsiClass clazz); + /** + * @param clazz class to check + * @return a pretty class name. e.x. for Kotlin it allows to return `MyClass` instead of `MyClass.Companion` + */ @Contract(pure = true) default @Nullable String getMainClassName(@NotNull PsiClass clazz) { return ClassUtil.getJVMClassName(clazz); } + /** + * @param psiElement element to check + * @return true if the given element or its parent is the main method, false otherwise + */ @Contract(pure = true) default boolean isMain(@NotNull PsiElement psiElement) { PsiMethod psiMethod = PsiTreeUtil.getParentOfType(psiElement, PsiMethod.class);