Package com.intellij.psi.codeStyle

Class JavaCodeStyleManager

java.lang.Object

com.intellij.psi.codeStyle.JavaCodeStyleManager

Direct Known Subclasses:

CoreJavaCodeStyleManager, JavaCodeStyleManagerImpl

public abstract class JavaCodeStyleManager
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	DO_NOT_ADD_IMPORTS
static int	INCOMPLETE_CODE

Constructor Summary

Constructors

Constructor and Description
JavaCodeStyleManager()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addImport(PsiJavaFile file, PsiClass refClass)
abstract int	findEntryIndex(PsiImportStatementBase statement)
abstract java.util.Collection<PsiImportStatementBase>	findRedundantImports(PsiJavaFile file)
static JavaCodeStyleManager	getInstance(Project project)
abstract java.lang.String	getPrefixByVariableKind(VariableKind variableKind)
abstract java.lang.String	getSuffixByVariableKind(VariableKind variableKind)
VariableKind	getVariableKind(PsiVariable variable) Returns the kind of the specified variable (local, parameter, field, static field or static final field).
boolean	hasConflictingOnDemandImport(PsiJavaFile file, PsiClass psiClass, java.lang.String referenceName) Single-static-import import static classFQN.referenceName; shadows on-demand static imports, like described JLS 6.4.1 A single-static-import declaration d in a compilation unit c of package p that imports a {member} named n shadows the declaration of any static {member} named n imported by a static-import-on-demand declaration in c, throughout c.
abstract void	optimizeImports(PsiFile file) Optimizes imports in the specified Java or JSP file.
abstract PsiImportList	prepareOptimizeImportsResult(PsiJavaFile file) Calculates the import list that would be substituted in the specified Java or JSP file if an Optimize Imports operation was performed on it.
abstract java.lang.String	propertyNameToVariableName(java.lang.String propertyName, VariableKind variableKind) Appends code style defined prefixes and/or suffixes for the specified variable kind to the specified variable name.
abstract PsiElement	qualifyClassReferences(PsiElement element) Replaces all references to Java classes in the contents of the specified element, except for references to classes in the same package or in implicitly imported packages, with full-qualified references.
abstract void	removeRedundantImports(PsiJavaFile file) Removes unused import statements from the specified Java file.
abstract PsiElement	shortenClassReferences(PsiElement element) Replaces fully-qualified class names in the contents of the specified element with non-qualified names and adds import statements as necessary.
abstract PsiElement	shortenClassReferences(PsiElement element, int flags)
abstract void	shortenClassReferences(PsiElement element, int startOffset, int endOffset) Replaces fully-qualified class names in a part of contents of the specified element with non-qualified names and adds import statements as necessary.
SuggestedNameInfo	suggestCompiledParameterName(PsiType type) Generates compiled parameter name for given type.
abstract SuggestedNameInfo	suggestNames(java.util.Collection<java.lang.String> semanticNames, VariableKind kind, PsiType type)
abstract java.util.Collection<java.lang.String>	suggestSemanticNames(PsiExpression expression) This method is not actually tied to Java Code Style.
abstract java.lang.String	suggestUniqueVariableName(java.lang.String baseName, PsiElement place, boolean lookForward) Suggests a unique name for the variable used at the specified location.
abstract java.lang.String	suggestUniqueVariableName(java.lang.String baseName, PsiElement place, java.util.function.Predicate<? super PsiVariable> canBeReused) Suggests a unique name for the variable used at the specified location looking forward with possible filtering.
SuggestedNameInfo	suggestUniqueVariableName(SuggestedNameInfo baseNameInfo, PsiElement place, boolean lookForward) Suggests a unique names for the variable used at the specified location.
abstract SuggestedNameInfo	suggestUniqueVariableName(SuggestedNameInfo baseNameInfo, PsiElement place, boolean ignorePlaceName, boolean lookForward) Suggests a unique name for the variable used at the specified location.
SuggestedNameInfo	suggestVariableName(VariableKind kind, java.lang.String propertyName, PsiExpression expr, PsiType type)
abstract SuggestedNameInfo	suggestVariableName(VariableKind kind, java.lang.String propertyName, PsiExpression expr, PsiType type, boolean correctKeywords)
abstract java.lang.String	variableNameToPropertyName(java.lang.String name, VariableKind variableKind) Generates a stripped-down name (with no code style defined prefixes or suffixes, usable as a property name) from the specified name of a variable of the specified kind.

Methods inherited from class java.lang.Object

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

Field Detail

DO_NOT_ADD_IMPORTS

public static final int DO_NOT_ADD_IMPORTS

See Also:

Constant Field Values

INCOMPLETE_CODE

public static final int INCOMPLETE_CODE

See Also:

Constant Field Values

Constructor Detail

JavaCodeStyleManager

public JavaCodeStyleManager()

Method Detail

getInstance

public static JavaCodeStyleManager getInstance(Project project)

addImport

public abstract boolean addImport(PsiJavaFile file,
                                  PsiClass refClass)

shortenClassReferences

public abstract PsiElement shortenClassReferences(PsiElement element,
                                                  int flags)
                                           throws IncorrectOperationException

Throws:

IncorrectOperationException

getPrefixByVariableKind

public abstract java.lang.String getPrefixByVariableKind(VariableKind variableKind)

getSuffixByVariableKind

public abstract java.lang.String getSuffixByVariableKind(VariableKind variableKind)

findEntryIndex

public abstract int findEntryIndex(PsiImportStatementBase statement)

shortenClassReferences

public abstract PsiElement shortenClassReferences(PsiElement element)
                                           throws IncorrectOperationException

Replaces fully-qualified class names in the contents of the specified element with non-qualified names and adds import statements as necessary.

Parameters:

element - the element to shorten references in.

Returns:

the element in the PSI tree after the shorten references operation corresponding to the original element.

Throws:

IncorrectOperationException - if the file to shorten references in is read-only.

shortenClassReferences

public abstract void shortenClassReferences(PsiElement element,
                                            int startOffset,
                                            int endOffset)
                                     throws IncorrectOperationException

Replaces fully-qualified class names in a part of contents of the specified element with non-qualified names and adds import statements as necessary.

Parameters:

element - the element to shorten references in.

startOffset - the start offset in the element of the part where class references are shortened.

endOffset - the end offset in the element of the part where class references are shortened.

Throws:

IncorrectOperationException - if the file to shorten references in is read-only.

optimizeImports

public abstract void optimizeImports(PsiFile file)
                              throws IncorrectOperationException

Optimizes imports in the specified Java or JSP file.

Parameters:

file - the file to optimize the imports in.

Throws:

IncorrectOperationException - if the file is read-only.

prepareOptimizeImportsResult

public abstract PsiImportList prepareOptimizeImportsResult(PsiJavaFile file)

Calculates the import list that would be substituted in the specified Java or JSP file if an Optimize Imports operation was performed on it.

Parameters:

file - the file to calculate the import list for.

Returns:

the calculated import list, or null when the file has no import list.

hasConflictingOnDemandImport

public boolean hasConflictingOnDemandImport(PsiJavaFile file,
                                            PsiClass psiClass,
                                            java.lang.String referenceName)

Single-static-import import static classFQN.referenceName; shadows on-demand static imports, like described JLS 6.4.1 A single-static-import declaration d in a compilation unit c of package p that imports a {member} named n shadows the declaration of any static {member} named n imported by a static-import-on-demand declaration in c, throughout c.

Returns:

true if file contains import which would be shadowed false otherwise

getVariableKind

public VariableKind getVariableKind(PsiVariable variable)

Returns the kind of the specified variable (local, parameter, field, static field or static final field).

Parameters:

variable - the variable to get the kind for.

Returns:

the variable kind.

suggestVariableName

public SuggestedNameInfo suggestVariableName(VariableKind kind,
                                             java.lang.String propertyName,
                                             PsiExpression expr,
                                             PsiType type)

suggestCompiledParameterName

public SuggestedNameInfo suggestCompiledParameterName(PsiType type)

Generates compiled parameter name for given type. Should not access indices due to performance reasons (e.g. see IDEA-116803)

suggestVariableName

public abstract SuggestedNameInfo suggestVariableName(VariableKind kind,
                                                      java.lang.String propertyName,
                                                      PsiExpression expr,
                                                      PsiType type,
                                                      boolean correctKeywords)

variableNameToPropertyName

public abstract java.lang.String variableNameToPropertyName(java.lang.String name,
                                                            VariableKind variableKind)

Generates a stripped-down name (with no code style defined prefixes or suffixes, usable as a property name) from the specified name of a variable of the specified kind.

Parameters:

name - the name of the variable.

variableKind - the kind of the variable.

Returns:

the stripped-down name.

propertyNameToVariableName

public abstract java.lang.String propertyNameToVariableName(java.lang.String propertyName,
                                                            VariableKind variableKind)

Appends code style defined prefixes and/or suffixes for the specified variable kind to the specified variable name.

Parameters:

propertyName - the base name of the variable.

variableKind - the kind of the variable.

Returns:

the variable name.

suggestUniqueVariableName

public abstract java.lang.String suggestUniqueVariableName(java.lang.String baseName,
                                                           PsiElement place,
                                                           boolean lookForward)

Suggests a unique name for the variable used at the specified location. The returned name is guaranteed to not shadow the existing name.

Parameters:

baseName - the base name for the variable.

place - the location where the variable will be used.

lookForward - if true, the existing variables are searched in both directions; if false - only backward

Returns:

the generated unique name,

suggestUniqueVariableName

public SuggestedNameInfo suggestUniqueVariableName(SuggestedNameInfo baseNameInfo,
                                                   PsiElement place,
                                                   boolean lookForward)

Suggests a unique names for the variable used at the specified location. The resulting name info may contain names which shadow existing names.

Parameters:

baseNameInfo - the base name info for the variable.

place - the location where the variable will be used.

lookForward - if true, the existing variables are searched in both directions; if false - only backward

Returns:

the generated unique name info.

suggestUniqueVariableName

public abstract java.lang.String suggestUniqueVariableName(java.lang.String baseName,
                                                           PsiElement place,
                                                           java.util.function.Predicate<? super PsiVariable> canBeReused)

Suggests a unique name for the variable used at the specified location looking forward with possible filtering.

Parameters:

baseName - the base name info for the variable.

place - the location where the variable will be used.

canBeReused - a predicate which returns true for variables which names still could be reused (e.g. a variable will be deleted during the ongoing refactoring)

Returns:

the generated unique name

suggestUniqueVariableName

public abstract SuggestedNameInfo suggestUniqueVariableName(SuggestedNameInfo baseNameInfo,
                                                            PsiElement place,
                                                            boolean ignorePlaceName,
                                                            boolean lookForward)

Suggests a unique name for the variable used at the specified location.

Parameters:

baseNameInfo - the base name info for the variable.

place - the location where the variable will be used.

ignorePlaceName - if true and place is PsiNamedElement, place.getName() would be still treated as unique name

lookForward - if true, the existing variables are searched in both directions; if false - only backward

Returns:

the generated unique name

qualifyClassReferences

public abstract PsiElement qualifyClassReferences(PsiElement element)

Replaces all references to Java classes in the contents of the specified element, except for references to classes in the same package or in implicitly imported packages, with full-qualified references.

Parameters:

element - the element to replace the references in.

Returns:

the element in the PSI tree after the qualify operation corresponding to the original element.

removeRedundantImports

public abstract void removeRedundantImports(PsiJavaFile file)
                                     throws IncorrectOperationException

Removes unused import statements from the specified Java file.

Parameters:

file - the file to remove the import statements from.

Throws:

IncorrectOperationException - if the operation fails for some reason (for example, the file is read-only).

findRedundantImports

public abstract java.util.Collection<PsiImportStatementBase> findRedundantImports(PsiJavaFile file)

suggestSemanticNames

public abstract java.util.Collection<java.lang.String> suggestSemanticNames(PsiExpression expression)

This method is not actually tied to Java Code Style. This method doesn't add prefixes or suffixes, and doesn't apply keyword correction. Returned names already have proper pluralization.

Should be used with suggestNames(Collection, VariableKind, PsiType).

suggestNames

public abstract SuggestedNameInfo suggestNames(java.util.Collection<java.lang.String> semanticNames,
                                               VariableKind kind,
                                               PsiType type)