diff --git a/java/java-psi-api/src/com/intellij/psi/PsiClass.java b/java/java-psi-api/src/com/intellij/psi/PsiClass.java index f4448e5215f9..4f0197a1b970 100644 --- a/java/java-psi-api/src/com/intellij/psi/PsiClass.java +++ b/java/java-psi-api/src/com/intellij/psi/PsiClass.java @@ -20,6 +20,9 @@ import java.util.List; /** * Represents a Java class or interface. + *

+ * To display the class name in the UI, taking into account the context where the class is defined, + * consider using {@link com.intellij.psi.presentation.java.ClassPresentationUtil#getNameForClass}. * * @see PsiJavaFile#getClasses() */ diff --git a/java/java-psi-impl/src/com/intellij/psi/presentation/java/ClassPresentationUtil.java b/java/java-psi-impl/src/com/intellij/psi/presentation/java/ClassPresentationUtil.java index ec690279f117..95f1d21918fe 100644 --- a/java/java-psi-impl/src/com/intellij/psi/presentation/java/ClassPresentationUtil.java +++ b/java/java-psi-impl/src/com/intellij/psi/presentation/java/ClassPresentationUtil.java @@ -15,6 +15,21 @@ public final class ClassPresentationUtil { private ClassPresentationUtil() { } + /** + * Returns a human-readable name for the class, including its containing context for local and anonymous classes. + *

+ * Examples: + *

+ * + * @param aClass the class to get the name for + * @param qualified if {@code true}, uses fully qualified names where applicable + * @return a presentable name suitable for UI display + */ public static @Nls String getNameForClass(@NotNull PsiClass aClass, boolean qualified) { if (aClass instanceof PsiImplicitClass) { String name = aClass.getQualifiedName();