Class IntroduceParameterObjectDescriptor.Parameter
- java.lang.Object
-
- org.eclipse.jdt.core.refactoring.descriptors.IntroduceParameterObjectDescriptor.Parameter
-
- Enclosing class:
- IntroduceParameterObjectDescriptor
public static class IntroduceParameterObjectDescriptor.Parameter extends Object
Instances of Parameter are used to describe the position of parameter and fields.
-
-
Constructor Summary
Constructors Constructor Description Parameter(int index)
Creates a new parameter object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getFieldName()
The name of the field that will be created ifisCreateField()
istrue
int
getIndex()
The index of the parameter in the original method signature.boolean
isCreateField()
Iftrue
the parameter will be removed from the method's signature and will be added to the parameter object.void
setCreateField(boolean createField)
Sets whether the parameter will be removed from the method's signature or will be added to the parameter object.void
setFieldName(String fieldName)
Sets the name of the field that will be created in the parameter object ifisCreateField()
istrue
.
-
-
-
Constructor Detail
-
Parameter
public Parameter(int index)
Creates a new parameter object. It is not recommended to call this constructor directly. UseIntroduceParameterObjectDescriptor.createParameters(IMethod)
instead.- Parameters:
index
- the index of the parameter in the method
-
-
Method Detail
-
getFieldName
public String getFieldName()
The name of the field that will be created ifisCreateField()
istrue
- Returns:
- the field name
- See Also:
isCreateField()
,setFieldName(String)
-
getIndex
public int getIndex()
The index of the parameter in the original method signature. The parameter object has the special indexIntroduceParameterObjectDescriptor.PARAMETER_OBJECT_IDX
. The position in the new method signature depends on the position in the array passed toIntroduceParameterObjectDescriptor.setParameters(IntroduceParameterObjectDescriptor.Parameter[])
- Returns:
- returns the index of the parameter in the original method signature or
IntroduceParameterObjectDescriptor.PARAMETER_OBJECT_IDX
for the parameter object - See Also:
IntroduceParameterObjectDescriptor.PARAMETER_OBJECT
,IntroduceParameterObjectDescriptor.PARAMETER_OBJECT_IDX
,IntroduceParameterObjectDescriptor.setParameters(IntroduceParameterObjectDescriptor.Parameter[])
-
isCreateField
public boolean isCreateField()
Iftrue
the parameter will be removed from the method's signature and will be added to the parameter object. The default isfalse
- Returns:
true
if the parameter will be created as field,false
if it will remain in the method
-
setCreateField
public void setCreateField(boolean createField)
Sets whether the parameter will be removed from the method's signature or will be added to the parameter object. The default isfalse
. Changing the creatField property of the parameter object will throw aIllegalArgumentException
- Parameters:
createField
-true
if the parameter should be created as field,false
if it will remain in the method
-
setFieldName
public void setFieldName(String fieldName)
Sets the name of the field that will be created in the parameter object ifisCreateField()
istrue
. Changing the fieldName of the parameter object will throw aIllegalArgumentException
- Parameters:
fieldName
- the new name of the field. Anull
indicates that the field name should be automatically derived- See Also:
isCreateField()
-
-