oracle.jdeveloper.java.util

Class VariableNaming

java.lang.Object

oracle.jdeveloper.java.util.VariableNaming

public final class VariableNaming
extends java.lang.Object

Contains utility methods that help with the naming of fields and variables.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VariableNaming.IntroduceVariableScopeStatus Enum to describe possible return values for method canIntroduceVariableInScope(SourceElement, String).
static class	VariableNaming.VariableType Enum of the various variable types that names can be generated for.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	canIntroduceField(SourceElement sourceElement, java.lang.String fieldName) Verifies if a field can be introduced in the class that contains the SourceElement.
static boolean	canIntroduceVariable(SourceElement scopeElement, java.lang.String variableName) Checks if a local variable (or method parameter or lambda parameter or catch parameter) with the variableName name can be introduced within the scope of scopeElement .
static VariableNaming.IntroduceVariableScopeStatus	canIntroduceVariableInScope(SourceElement scopeElement, java.lang.String variableName) Checks if a variable (or method parameter or lambda parameter or catch parameter) with the variableName name can be introduced within the scope of scopeElement.
static void	fillWithMembers(SourceElement element, java.util.HashSet<java.lang.String> existingNames) Fills the set with the names of existing field declarations visible from the sourceElement.
static void	fillWithParentVariableDeclaration(SourceElement sourceElement, java.util.HashSet<java.lang.String> existingNames) Fills the set with the names of variables in all the parent scopes of the sourceElement.
static java.lang.String	format(VariableNaming.VariableType variableType, java.lang.String name) Format the given name for the code style of the given variableType.
static boolean	hasShadowedFieldUses(SourceElement sourceVariable, java.lang.String newVariableName) Checks if the new name of a formal parameter or local variable would shadow a field that has uses within the paramater's or local variable's surrounding scope or any scope contained in that surrounding scope.
static boolean	isFieldShadowing(SourceElement element, java.lang.String newVariableName) Deprecated. Use hasFieldShadowing(SourceElement, String) instead
static java.util.List<java.lang.String>	suggestNames(SourceElement sourceElement, java.lang.String typeName, VariableNaming.VariableType variableType, java.lang.String currentName) Suggest names for the given source element.
static java.util.List<java.lang.String>	suggestNamesFromCamelWord(java.lang.String shortName, VariableNaming.VariableType variableType) Suggest names based on the given word (in camel case).

Methods inherited from class java.lang.Object

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

Method Detail

format

public static java.lang.String format(VariableNaming.VariableType variableType,
                                      java.lang.String name)

Format the given name for the code style of the given variableType.

Parameters:

variableType - A variableType

name - A name

Returns:

canIntroduceVariable

public static boolean canIntroduceVariable(SourceElement scopeElement,
                                           java.lang.String variableName)

Checks if a local variable (or method parameter or lambda parameter or catch parameter) with the variableName name can be introduced within the scope of scopeElement .

This method checks also for shadowed fields. If you want to allow field shadowing, use canIntroduceVariableInScope(SourceElement,String) instead.

Parameters:

scopeElement - The element whose scope should be checked, this is the scope where the variable will be introduced.

variableName - The name of the newly introduced variable.

Returns:

True if variableName does not already represent a variable within the scope of scopeElement and the variable does not shadow a field.

canIntroduceVariableInScope

public static VariableNaming.IntroduceVariableScopeStatus canIntroduceVariableInScope(SourceElement scopeElement,
                                                                                      java.lang.String variableName)

Checks if a variable (or method parameter or lambda parameter or catch parameter) with the variableName name can be introduced within the scope of scopeElement.

Parameters:

scopeElement - The element whose scope should be checked, this is the scope where the variable will be introduced.

variableName - The name of the newly introduced variable.

Returns:

One of the possible check statuses, null is never returned, please see the description of each status.

suggestNamesFromCamelWord

public static java.util.List<java.lang.String> suggestNamesFromCamelWord(java.lang.String shortName,
                                                                         VariableNaming.VariableType variableType)

Suggest names based on the given word (in camel case). The variableType is optional and if given will ensure the names conform to current naming style.

Parameters:

shortName - A name which is assumed to be in camel case

variableType - If not null, a VariableType to use for formatting

Returns:

A sorted List of names which will not be null but might be empty

suggestNames

public static java.util.List<java.lang.String> suggestNames(SourceElement sourceElement,
                                                            java.lang.String typeName,
                                                            VariableNaming.VariableType variableType,
                                                            java.lang.String currentName)

Suggest names for the given source element. If the element has a name itself then the suggested names will be based on that. If the element is a method call or a dot expression then extra suggestions can be generated. If the element is catch clause, names 'e', 'ex', 'exception' are generated. The given type name is optional, and if supplied it will be used as a basis for more sugestions. If suggestions clash with existing names, then the suggestions are slightly modified to avoid clashing ( usually by adding a number). Clashes with the current name will not be modified.

Parameters:

sourceElement - get suggestions for this element

typeName - optional type name to get more suggestions for

variableType - If not null, a VariableType to use for formatting

currentName - do not modify suggestions (e.g. add a" _2") if they clash with this name

Returns:

A sorted List of names which will not be null but might be empty

fillWithMembers

public static void fillWithMembers(SourceElement element,
                                   java.util.HashSet<java.lang.String> existingNames)

Fills the set with the names of existing field declarations visible from the sourceElement.

Parameters:

element - A SourceElement

existingNames - A HashSet for the names found

fillWithParentVariableDeclaration

public static void fillWithParentVariableDeclaration(SourceElement sourceElement,
                                                     java.util.HashSet<java.lang.String> existingNames)

Fills the set with the names of variables in all the parent scopes of the sourceElement.

Parameters:

sourceElement - A SourceElement

existingNames - A Set to fill with variable names

canIntroduceField

public static java.lang.String canIntroduceField(SourceElement sourceElement,
                                                 java.lang.String fieldName)

Verifies if a field can be introduced in the class that contains the SourceElement. It will verify that the field name is a valid field identifier, that it does not already exist, that there is an enclosing class scope for the SourceElement and that it does not override a variable in the enclosing class scope.

Parameters:

sourceElement - A SourceElement with an enclosing class scope

fieldName - The name of the new field

Returns:

null if the field name can be introduced, or an error message describing why the field name cannot be introduced

hasShadowedFieldUses

public static boolean hasShadowedFieldUses(SourceElement sourceVariable,
                                           java.lang.String newVariableName)

Checks if the new name of a formal parameter or local variable would shadow a field that has uses within the paramater's or local variable's surrounding scope or any scope contained in that surrounding scope. Introduction of such a name that shadows a field could require qualifying the existing uses of the field.

Note that this checks for uses of a shadowed field. Use CanIntroduceVariableInScope to find if a variable name would shadow a field.

Parameters:

sourceVariable - A formal parameter or local variable

newVariableName - The new variable name

Returns:

True if the newVariableName would shadow a field with uses

isFieldShadowing

public static boolean isFieldShadowing(SourceElement element,
                                       java.lang.String newVariableName)

Deprecated. Use hasFieldShadowing(SourceElement, String) instead