oracle.jdeveloper.java.util

Class VariableNaming

java.lang.Object

oracle.jdeveloper.java.util.VariableNaming

public final class VariableNaming
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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 added introduced to the class that contains the SourceElement.
static boolean	canIntroduceVariable(SourceElement sourceElement, java.lang.String variableName)
static void	fillWithMembers(SourceElement element, java.util.HashSet existingNames) Fills the set with the existing member declarations visible from the sourceElement.
static void	fillWithParentVariableDeclaration(SourceElement sourceElement, java.util.HashSet<java.lang.String> existingNames) Fills the set with the existing variable declarations visible from 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	isFieldShadowing(SourceElement element, java.lang.String newVariableName) Checks if the new name of a formal parameter or local variable would shadow a field within its scope.
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 -

name -

Returns:

canIntroduceVariable

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

Returns:

true if variableName does not already represent something at sourceElement. Something can be a variable name, a field name, a class name, ...

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 -

variableType -

Returns:

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 - the type of variable being named

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

Returns:

fillWithMembers

public static void fillWithMembers(SourceElement element,
                                   java.util.HashSet existingNames)

Fills the set with the existing member declarations visible from the sourceElement.

fillWithParentVariableDeclaration

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

Fills the set with the existing variable declarations visible from the sourceElement

canIntroduceField

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

Verifies if a field can added introduced to the class that contains the SourceElement. It will verify that the field name is a valid field identifier, that it does not already exist and that it does not override a variable in the method that contains the sourceElement

Parameters:

sourceElement -

fieldName -

Returns:

the error message if it is not a valid variable name

isFieldShadowing

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

Checks if the new name of a formal parameter or local variable would shadow a field within its scope.

Parameters:

element - A formal parameter or local variable

newVariableName - The new element name

Returns:

True if the name would clas