Package com.intellij.core

Class CoreJavaCodeStyleManager

java.lang.Object

com.intellij.psi.codeStyle.JavaCodeStyleManager

com.intellij.core.CoreJavaCodeStyleManager

public class CoreJavaCodeStyleManager
extends JavaCodeStyleManager

Field Summary

Fields inherited from class com.intellij.psi.codeStyle.JavaCodeStyleManager

DO_NOT_ADD_IMPORTS, INCOMPLETE_CODE

Constructor Summary

Constructors

Constructor and Description
CoreJavaCodeStyleManager()

Method Summary

Modifier and Type	Method and Description
boolean	addImport(PsiJavaFile file, PsiClass refClass)
int	findEntryIndex(PsiImportStatementBase statement)
java.util.Collection<PsiImportStatementBase>	findRedundantImports(PsiJavaFile file)
java.lang.String	getPrefixByVariableKind(VariableKind variableKind)
java.lang.String	getSuffixByVariableKind(VariableKind variableKind)
void	optimizeImports(PsiFile file) Optimizes imports in the specified Java or JSP file.
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.
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.
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.
void	removeRedundantImports(PsiJavaFile file) Removes unused import statements from the specified Java file.
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.
PsiElement	shortenClassReferences(PsiElement element, int flags)
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	suggestNames(java.util.Collection<java.lang.String> semanticNames, VariableKind kind, PsiType type)
java.util.Collection<java.lang.String>	suggestSemanticNames(PsiExpression expression) This method is not actually tied to Java Code Style.
java.lang.String	suggestUniqueVariableName(java.lang.String baseName, PsiElement place, boolean lookForward) Suggests a unique name for the variable used at the specified location.
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 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, boolean correctKeywords)
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 com.intellij.psi.codeStyle.JavaCodeStyleManager

getInstance, getVariableKind, hasConflictingOnDemandImport, suggestCompiledParameterName, suggestUniqueVariableName, suggestVariableName

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreJavaCodeStyleManager

public CoreJavaCodeStyleManager()

Method Detail

addImport

public boolean addImport(PsiJavaFile file,
                         PsiClass refClass)

Specified by:

addImport in class JavaCodeStyleManager

shortenClassReferences

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

Specified by:

shortenClassReferences in class JavaCodeStyleManager

Throws:

IncorrectOperationException

getPrefixByVariableKind

public java.lang.String getPrefixByVariableKind(VariableKind variableKind)

Specified by:

getPrefixByVariableKind in class JavaCodeStyleManager

getSuffixByVariableKind

public java.lang.String getSuffixByVariableKind(VariableKind variableKind)

Specified by:

getSuffixByVariableKind in class JavaCodeStyleManager

findEntryIndex

public int findEntryIndex(PsiImportStatementBase statement)

Specified by:

findEntryIndex in class JavaCodeStyleManager

shortenClassReferences

public PsiElement shortenClassReferences(PsiElement element)
                                  throws IncorrectOperationException

Description copied from class: JavaCodeStyleManager

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

Specified by:

shortenClassReferences in class JavaCodeStyleManager

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 void shortenClassReferences(PsiElement element,
                                   int startOffset,
                                   int endOffset)
                            throws IncorrectOperationException

Description copied from class: JavaCodeStyleManager

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

Specified by:

shortenClassReferences in class JavaCodeStyleManager

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 void optimizeImports(PsiFile file)
                     throws IncorrectOperationException

Description copied from class: JavaCodeStyleManager

Optimizes imports in the specified Java or JSP file.

Specified by:

optimizeImports in class JavaCodeStyleManager

Parameters:

file - the file to optimize the imports in.

Throws:

IncorrectOperationException - if the file is read-only.

prepareOptimizeImportsResult

public PsiImportList prepareOptimizeImportsResult(PsiJavaFile file)

Description copied from class: JavaCodeStyleManager

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

Specified by:

prepareOptimizeImportsResult in class JavaCodeStyleManager

Parameters:

file - the file to calculate the import list for.

Returns:

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

suggestVariableName

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

Specified by:

suggestVariableName in class JavaCodeStyleManager

variableNameToPropertyName

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

Description copied from class: JavaCodeStyleManager

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.

Specified by:

variableNameToPropertyName in class JavaCodeStyleManager

Parameters:

name - the name of the variable.

variableKind - the kind of the variable.

Returns:

the stripped-down name.

propertyNameToVariableName

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

Description copied from class: JavaCodeStyleManager

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

Specified by:

propertyNameToVariableName in class JavaCodeStyleManager

Parameters:

propertyName - the base name of the variable.

variableKind - the kind of the variable.

Returns:

the variable name.

suggestUniqueVariableName

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

Description copied from class: JavaCodeStyleManager

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

Specified by:

suggestUniqueVariableName in class JavaCodeStyleManager

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 java.lang.String suggestUniqueVariableName(java.lang.String baseName,
                                                  PsiElement place,
                                                  java.util.function.Predicate<? super PsiVariable> canBeReused)

Description copied from class: JavaCodeStyleManager

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

Specified by:

suggestUniqueVariableName in class JavaCodeStyleManager

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 SuggestedNameInfo suggestUniqueVariableName(SuggestedNameInfo baseNameInfo,
                                                   PsiElement place,
                                                   boolean ignorePlaceName,
                                                   boolean lookForward)

Description copied from class: JavaCodeStyleManager

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

Specified by:

suggestUniqueVariableName in class JavaCodeStyleManager

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 PsiElement qualifyClassReferences(PsiElement element)

Description copied from class: JavaCodeStyleManager

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.

Specified by:

qualifyClassReferences in class JavaCodeStyleManager

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 void removeRedundantImports(PsiJavaFile file)
                            throws IncorrectOperationException

Description copied from class: JavaCodeStyleManager

Removes unused import statements from the specified Java file.

Specified by:

removeRedundantImports in class JavaCodeStyleManager

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 java.util.Collection<PsiImportStatementBase> findRedundantImports(PsiJavaFile file)

Specified by:

findRedundantImports in class JavaCodeStyleManager

suggestSemanticNames

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

Description copied from class: JavaCodeStyleManager

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 JavaCodeStyleManager.suggestNames(Collection, VariableKind, PsiType).

Specified by:

suggestSemanticNames in class JavaCodeStyleManager

suggestNames

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

Specified by:

suggestNames in class JavaCodeStyleManager