org.netbeans.modules.refactoring.java.api

Class ChangeParametersRefactoring

java.lang.Object

org.netbeans.modules.refactoring.api.AbstractRefactoring

org.netbeans.modules.refactoring.java.api.ChangeParametersRefactoring

public final class ChangeParametersRefactoring
extends AbstractRefactoring

Refactoring used for changing method signature. It changes method declaration and also all its references (callers).

See Also:

RefactoringPlugin, RefactoringPluginFactory, AbstractRefactoring, RefactoringSession

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChangeParametersRefactoring.ParameterInfo Represents one item for setParameters(List params) list parameter.

Field Summary

Fields inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring

INIT, PARAMETERS_CHECK, PRE_CHECK, PREPARE

Constructor Summary

Constructors

Constructor and Description
ChangeParametersRefactoring(TreePathHandle method) Creates a new instance of change parameters refactoring.

Method Summary

Methods

Modifier and Type	Method and Description
String	getMethodName() Get the new method name.
Set<Modifier>	getModifiers() Getter for new modifiers
ChangeParametersRefactoring.ParameterInfo[]	getParameterInfo() Getter for new parameters
String	getReturnType() Get the new return type.
boolean	isOverloadMethod() Create a new overloading method with the new parameter and let the existing method delegate to it: e.g.
void	setMethodName(String methodName) Sets the new method name.
void	setModifiers(Set<Modifier> modifiers) Sets modifiers for method
void	setOverloadMethod(boolean overloadMethod) Create a new overloading method with the new parameter and let the existing method delegate to it: e.g.
void	setParameterInfo(ChangeParametersRefactoring.ParameterInfo[] paramTable) Sets new parameters for a method
void	setReturnType(String returnType) Sets the new return type for the method.

Methods inherited from class org.netbeans.modules.refactoring.api.AbstractRefactoring

addProgressListener, cancelRequest, checkParameters, fastCheckParameters, getContext, getRefactoringSource, preCheck, prepare, removeProgressListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeParametersRefactoring

public ChangeParametersRefactoring(TreePathHandle method)

Creates a new instance of change parameters refactoring.

Parameters:

method - refactored object, i.e. method or constructor

Method Detail

getParameterInfo

public ChangeParametersRefactoring.ParameterInfo[] getParameterInfo()

Getter for new parameters

Returns:

array of new parameters

getModifiers

public Set<Modifier> getModifiers()

Getter for new modifiers

Returns:

modifiers

getReturnType

@CheckForNull
public String getReturnType()

Get the new return type.

Returns:

returnType, null if it will not change

Since:

1.25

getMethodName

@CheckForNull
public String getMethodName()

Get the new method name.

Returns:

methodName, null if it will no change

Since:

1.25

setParameterInfo

public void setParameterInfo(ChangeParametersRefactoring.ParameterInfo[] paramTable)

Sets new parameters for a method

Parameters:

paramTable - new parameters

setModifiers

public void setModifiers(Set<Modifier> modifiers)

Sets modifiers for method

Parameters:

modifiers - new modifiers

setMethodName

public void setMethodName(@NullAllowed
                 String methodName)

Sets the new method name.

Parameters:

methodName - the new method name, null if it does not change

Since:

1.25

setReturnType

public void setReturnType(@NullAllowed
                 String returnType)

Sets the new return type for the method.

Parameters:

returnType - the return type to set, null if it does not change

Since:

1.25

isOverloadMethod

public boolean isOverloadMethod()

Create a new overloading method with the new parameter and let the existing method delegate to it: e.g.

 int foo() {
   return 1+1;
 }
 

if "1+1" is selected, the code is converted to

 int foo() {
    return foo(1+1);
 }
 
 int foo(int newparam) {
    return newparam;
 }
 

Returns:

true if a new overloading method will be created, false otherwise

Since:

1.28

setOverloadMethod

public void setOverloadMethod(boolean overloadMethod)

Create a new overloading method with the new parameter and let the existing method delegate to it: e.g.

 int foo() {
   return 1+1;
 }
 

if "1+1" is selected, the code is converted to

 int foo() {
    return foo(1+1);
 }
 
 int foo(int newparam) {
    return newparam;
 }
 

Parameters:

overloadMethod - true if you want to create a new overloading method

Since:

1.28