← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to refactoring/java/src/org/netbeans/modules/refactoring/java/ui/EncapsulateFieldsRefactoring.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
refactoring/java/src/org/netbeans/modules/refactoring/java/ui/EncapsulateFieldsRefactoring.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
package org.netbeans.modules.refactoring.java.ui;
 
42
 
 
43
import java.util.ArrayList;
 
44
import java.util.Collection;
 
45
import java.util.Collections;
 
46
import java.util.Set;
 
47
import javax.lang.model.element.Modifier;
 
48
import org.netbeans.api.java.source.TreePathHandle;
 
49
import org.netbeans.modules.refactoring.api.AbstractRefactoring;
 
50
import org.openide.util.lookup.Lookups;
 
51
 
 
52
/** Encapsulate fields refactoring. This is a composed refactoring (uses instances of {@link org.netbeans.modules.refactoring.api.EncapsulateFieldRefactoring}
 
53
 * to encapsulate several fields at once.
 
54
 *
 
55
 * @author Pavel Flaska
 
56
 * @author Jan Becicka
 
57
 * @author Jan Pokorsky
 
58
 */
 
59
public final class EncapsulateFieldsRefactoring extends AbstractRefactoring {
 
60
    
 
61
    private Collection<EncapsulateFieldInfo> refactorFields = Collections.emptyList();
 
62
    private Set<Modifier> methodModifiers = Collections.emptySet();
 
63
    private Set<Modifier> fieldModifiers = Collections.emptySet();;
 
64
    private boolean alwaysUseAccessors;
 
65
 
 
66
    /** Creates a new instance of EcapsulateFields.
 
67
     * @param selectedObject field to encapsulate, whatever tree of class
 
68
     *          containing trees to encapsulate
 
69
     */
 
70
    public EncapsulateFieldsRefactoring(TreePathHandle selectedObject) {
 
71
        super(Lookups.fixed(selectedObject));
 
72
    }
 
73
    
 
74
    /**
 
75
     * Getter for property refactorFields
 
76
     * @return Value of refactorFields
 
77
     */
 
78
    public Collection<EncapsulateFieldInfo> getRefactorFields() {
 
79
        return refactorFields;
 
80
    }
 
81
 
 
82
    /**
 
83
     * Getter for property methodModifier
 
84
     * @return Value of methodModifier
 
85
     */
 
86
    public Set<Modifier> getMethodModifiers() {
 
87
        return methodModifiers;
 
88
    }
 
89
 
 
90
    /**
 
91
     * Getter for property fieldModifier
 
92
     * @return Value of fieldModifier
 
93
     */
 
94
    public Set<Modifier> getFieldModifiers() {
 
95
        return fieldModifiers;
 
96
    }
 
97
 
 
98
    /**
 
99
     * Getter for property alwaysUseAccessors
 
100
     * @return Value of alwaysUseAccessors
 
101
     */
 
102
    public boolean isAlwaysUseAccessors() {
 
103
        return alwaysUseAccessors;
 
104
    }
 
105
    
 
106
    /**
 
107
     * Setter for property refactorFields
 
108
     * @param refactorFields New value of property refactorFields
 
109
     */
 
110
    public void setRefactorFields(Collection<EncapsulateFieldInfo> refactorFields) {
 
111
        this.refactorFields = Collections.unmodifiableCollection(
 
112
                new ArrayList<EncapsulateFieldInfo>(refactorFields));
 
113
    }
 
114
 
 
115
    /**
 
116
     * Setter for property methodModifier
 
117
     * @param methodModifier New value of property methodModifier
 
118
     */
 
119
    public void setMethodModifiers(Set<Modifier> methodModifier) {
 
120
        this.methodModifiers = methodModifier;
 
121
    }
 
122
 
 
123
    /**
 
124
     * Setter for property fieldModifier
 
125
     * @param fieldModifier New value of property fieldModifier
 
126
     */
 
127
    public void setFieldModifiers(Set<Modifier> fieldModifier) {
 
128
        this.fieldModifiers = fieldModifier;
 
129
    }
 
130
 
 
131
    /**
 
132
     * Setter for property alwaysUseAccessors
 
133
     * @param alwaysUseAccessors New value of property alwaysUseAccessors
 
134
     */
 
135
    public void setAlwaysUseAccessors(boolean alwaysUseAccessors) {
 
136
        this.alwaysUseAccessors = alwaysUseAccessors;
 
137
    }
 
138
 
 
139
    public TreePathHandle getSelectedObject() {
 
140
        return getRefactoringSource().lookup(TreePathHandle.class);
 
141
    }
 
142
    
 
143
 
 
144
    ////////////////////////////////////////////////////////////////////////////
 
145
    // INNER CLASSES
 
146
    ////////////////////////////////////////////////////////////////////////////
 
147
    /**
 
148
     * Represents data from the panel.
 
149
     */
 
150
    public static final class EncapsulateFieldInfo {
 
151
        TreePathHandle field;
 
152
        String getterName;
 
153
        String setterName;
 
154
        
 
155
        /**
 
156
         * Creates an instance of Encapsulate Field Info
 
157
         * @param field 
 
158
         * @param getterName 
 
159
         * @param setterName 
 
160
         */
 
161
        public EncapsulateFieldInfo(TreePathHandle field, String getterName, String setterName) {
 
162
            this.field = field;
 
163
            this.getterName = getterName;
 
164
            this.setterName = setterName;
 
165
        }
 
166
        
 
167
        /**
 
168
         * Getter for property getterName.
 
169
         *
 
170
         * @return Value of property getterName.
 
171
         */
 
172
        public String getGetterName() { return getterName; }
 
173
        
 
174
        /**
 
175
         * Getter for property setterName.
 
176
         * 
 
177
         * @return Value of property setterName.
 
178
         */
 
179
        public String getSetterName() { return setterName; }
 
180
        
 
181
        /**
 
182
         * Getter for property field.
 
183
         *
 
184
         * @return Value of property field.
 
185
         */
 
186
        public TreePathHandle getField() { return field; }
 
187
        
 
188
    }
 
189
}