Package com.intellij.refactoring.changeSignature

Interface ParameterInfo

All Known Subinterfaces:

JavaParameterInfo

All Known Implementing Classes:

GrParameterInfo, ParameterInfoImpl, PyParameterInfo

public interface ParameterInfo

Represents a parameter of a method affected by the "Change Signature" refactoring.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NEW_PARAMETER

Method Summary

Modifier and Type	Method and Description
default PsiElement	getActualValue(PsiElement callExpression, java.lang.Object substitutor) For added parameters, returns expression which should be created at the call site.
java.lang.String	getDefaultValue() For added parameters, returns the string representation of the default parameter value.
java.lang.String	getName() Returns the name of the parameter after the refactoring.
int	getOldIndex() Returns the index of the parameter in the old parameter list, or NEW_PARAMETER if the parameter was added by the refactoring.
java.lang.String	getTypeText() Returns parameter type text
default boolean	isNew() Returns true if the parameter was added by the refactoring.
boolean	isUseAnySingleVariable() Flag whether refactoring should use any appropriate nearby variable as the default value
void	setName(java.lang.String name) Set parameter new name (to be changed to during refactoring)
void	setUseAnySingleVariable(boolean b) Flag whether refactoring should use any appropriate nearby variable as the default value

Field Detail

NEW_PARAMETER

static final int NEW_PARAMETER

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the name of the parameter after the refactoring.

Returns:

parameter name.

getOldIndex

int getOldIndex()

Returns the index of the parameter in the old parameter list, or NEW_PARAMETER if the parameter was added by the refactoring.

Returns:

old parameter index, or NEW_PARAMETER.

isNew

default boolean isNew()

Returns true if the parameter was added by the refactoring.

Returns:

true if the parameter was added by the refactoring

getDefaultValue

java.lang.String getDefaultValue()

For added parameters, returns the string representation of the default parameter value.

Returns:

default value, or null if the parameter wasn't added.

getActualValue

default PsiElement getActualValue(PsiElement callExpression,
                                  java.lang.Object substitutor)

For added parameters, returns expression which should be created at the call site. By default it's expression based on getDefaultValue() string representation or default value for a type Could be overridden to provide values which depend on the call site

setName

void setName(java.lang.String name)

Set parameter new name (to be changed to during refactoring)

Parameters:

name - new name

getTypeText

java.lang.String getTypeText()

Returns parameter type text

Returns:

type text

isUseAnySingleVariable

boolean isUseAnySingleVariable()

Flag whether refactoring should use any appropriate nearby variable as the default value

Returns:

flag value

setUseAnySingleVariable

void setUseAnySingleVariable(boolean b)

Flag whether refactoring should use any appropriate nearby variable as the default value

Parameters:

b - new value