mirror of
https://gitflic.ru/project/openide/openide.git
synced 2026-09-27 10:03:11 +07:00
docs [java-psi]: add Javadoc for ClassPresentationUtil#getNameForClass and PsiClass
GitOrigin-RevId: eeb57d7509c02ab82e2ac963bdeaca9b0f1d89ad
This commit is contained in:
committed by
intellij-monorepo-bot
parent
e5c4ad4bb3
commit
fbbca2bf86
@@ -20,6 +20,9 @@ import java.util.List;
|
||||
|
||||
/**
|
||||
* Represents a Java class or interface.
|
||||
* <p>
|
||||
* 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()
|
||||
*/
|
||||
|
||||
@@ -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.
|
||||
* <p>
|
||||
* Examples:
|
||||
* <ul>
|
||||
* <li>Top-level class: {@code "MyClass"} (or {@code "com.example.MyClass"} if qualified)</li>
|
||||
* <li>Local class in method: {@code "LocalClass in method() in ContainerClass"}</li>
|
||||
* <li>Anonymous class: {@code "Anonymous in method() in ContainerClass"}</li>
|
||||
* <li>Enum constant initializer: {@code "CONSTANT in MyEnum"}</li>
|
||||
* </ul>
|
||||
*
|
||||
* @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();
|
||||
|
||||
Reference in New Issue
Block a user