update copyrights
[idea/community.git] / platform / lang-api / src / com / intellij / refactoring / changeSignature / ParameterInfo.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package com.intellij.refactoring.changeSignature;
18
19 import org.jetbrains.annotations.Nullable;
20
21 /**
22  * Represents a parameter of a method affected by the "Change Signature" refactoring.
23  *
24  * @author yole
25  * @since 8.1
26  */
27 public interface ParameterInfo {
28   /**
29    * Returns the name of the parameter after the refactoring.
30    *
31    * @return parameter name.
32    */
33   String getName();
34
35   /**
36    * Returns the index of the parameter in the old parameter list, or -1 if the parameter
37    * was added by the refactoring.
38    *
39    * @return old parameter index, or -1.
40    */
41   int getOldIndex();
42
43   /**
44    * For added parameters, returns the string representation of the default parameter value.
45    *
46    * @return default value, or null if the parameter wasn't added.
47    */
48   @Nullable
49   String getDefaultValue();
50 }