Package com.intellij.psi

Class PsiNameHelper

java.lang.Object

com.intellij.psi.PsiNameHelper

Direct Known Subclasses:

PsiNameHelperImpl

public abstract class PsiNameHelper
extends java.lang.Object

Service for validating and parsing Java identifiers.

Constructor Summary

Constructors

Constructor and Description
PsiNameHelper()

Method Summary

Modifier and Type	Method and Description
static boolean	appendAnnotations(java.lang.StringBuilder sb, java.util.List<? extends PsiAnnotation> annotations, boolean canonical)
static boolean	appendAnnotations(java.lang.StringBuilder sb, PsiAnnotation [] annotations, boolean canonical)
static void	appendTypeArgs(java.lang.StringBuilder sb, PsiType [] types, boolean canonical, boolean annotated)
static java.lang.String []	getClassParametersText(java.lang.String referenceText) Obtains text of all type parameter values in a reference.
static PsiNameHelper	getInstance(Project project)
static java.lang.String	getPresentableText(PsiJavaCodeReferenceElement ref)
static java.lang.String	getPresentableText(java.lang.String refName, PsiAnnotation [] annotations, PsiType [] types)
static java.lang.String	getQualifiedClassName(java.lang.String referenceText, boolean removeWhitespace)
static java.lang.String	getShortClassName(java.lang.String referenceText)
abstract boolean	isIdentifier(java.lang.String text) Checks if the specified text is a Java identifier, using the language level of the project with which the name helper is associated to filter out keywords.
abstract boolean	isIdentifier(java.lang.String text, LanguageLevel languageLevel) Checks if the specified text is a Java identifier, using the specified language level with which the name helper is associated to filter out keywords.
abstract boolean	isKeyword(java.lang.String text) Checks if the specified text is a Java keyword, using the language level of the project with which the name helper is associated.
abstract boolean	isQualifiedName(java.lang.String text) Checks if the specified string is a qualified name (sequence of identifiers separated by periods).
static boolean	isSubpackageOf(java.lang.String subpackageName, java.lang.String packageName)
static boolean	isValidModuleName(java.lang.String name, PsiElement context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PsiNameHelper

public PsiNameHelper()

Method Detail

getInstance

public static PsiNameHelper getInstance(Project project)

isIdentifier

public abstract boolean isIdentifier(java.lang.String text)

Checks if the specified text is a Java identifier, using the language level of the project with which the name helper is associated to filter out keywords.

Parameters:

text - the text to check.

Returns:

true if the text is an identifier, false otherwise

isIdentifier

public abstract boolean isIdentifier(java.lang.String text,
                                     LanguageLevel languageLevel)

Checks if the specified text is a Java identifier, using the specified language level with which the name helper is associated to filter out keywords.

Parameters:

text - the text to check.

languageLevel - to check text against. For instance 'assert' or 'enum' might or might not be identifiers depending on language level

Returns:

true if the text is an identifier, false otherwise

isKeyword

public abstract boolean isKeyword(java.lang.String text)

Checks if the specified text is a Java keyword, using the language level of the project with which the name helper is associated.

Parameters:

text - the text to check.

Returns:

true if the text is a keyword, false otherwise

isQualifiedName

public abstract boolean isQualifiedName(java.lang.String text)

Checks if the specified string is a qualified name (sequence of identifiers separated by periods).

Parameters:

text - the text to check.

Returns:

true if the text is a qualified name, false otherwise.

getShortClassName

public static java.lang.String getShortClassName(java.lang.String referenceText)

getPresentableText

public static java.lang.String getPresentableText(PsiJavaCodeReferenceElement ref)

Parameters:

ref - reference to get presentable text for

Returns:

presentable text that contains a reference name and presentable text of type parameters, if any. No annotations are displayed

getPresentableText

public static java.lang.String getPresentableText(java.lang.String refName,
                                                  PsiAnnotation [] annotations,
                                                  PsiType [] types)

Parameters:

refName - name of a reference to get presentable text for

annotations - reference annotations

types - reference type parameters

Returns:

presentable text that contains supplied annotations, a reference name and presentable text of type parameters, if any, including their annotations.

getQualifiedClassName

public static java.lang.String getQualifiedClassName(java.lang.String referenceText,
                                                     boolean removeWhitespace)

getClassParametersText

public static java.lang.String [] getClassParametersText(java.lang.String referenceText)

Obtains text of all type parameter values in a reference. They go in left-to-right order: A<List<String>, B<Integer>> yields ["List<String>", "B<Integer>"]. Parameters of the outer reference are ignored: A<List<String>>.B<Integer> yields ["Integer"]

Parameters:

referenceText - the text of the reference to calculate type parameters for.

Returns:

the calculated array of type parameters.

isSubpackageOf

public static boolean isSubpackageOf(java.lang.String subpackageName,
                                     java.lang.String packageName)

appendTypeArgs

public static void appendTypeArgs(java.lang.StringBuilder sb,
                                  PsiType [] types,
                                  boolean canonical,
                                  boolean annotated)

appendAnnotations

public static boolean appendAnnotations(java.lang.StringBuilder sb,
                                        PsiAnnotation [] annotations,
                                        boolean canonical)

appendAnnotations

public static boolean appendAnnotations(java.lang.StringBuilder sb,
                                        java.util.List<? extends PsiAnnotation> annotations,
                                        boolean canonical)

isValidModuleName

public static boolean isValidModuleName(java.lang.String name,
                                        PsiElement context)