Skip to content

Commit e828f5c

Browse files
committed
More refactoring
- Avoid using ParametricRuleViolation - Delete unused code (taskmarker) - Use generics
1 parent 0455cc0 commit e828f5c

File tree

10 files changed

+91
-53
lines changed

10 files changed

+91
-53
lines changed

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/PMDRuntimeConstants.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
package net.sourceforge.pmd.eclipse.runtime;
66

77
import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
8-
import net.sourceforge.pmd.properties.IntegerProperty;
98

109
/**
1110
* This interface groups all plugin constants
@@ -36,7 +35,8 @@ public final class PMDRuntimeConstants {
3635
* which was 1000 violations.
3736
*/
3837
@Deprecated
39-
public static final IntegerProperty MAX_VIOLATIONS_DESCRIPTOR = new IntegerProperty("maxviolations",
38+
public static final net.sourceforge.pmd.properties.IntegerProperty MAX_VIOLATIONS_DESCRIPTOR =
39+
new net.sourceforge.pmd.properties.IntegerProperty("maxviolations",
4040
"Max allowable violations", 1, Integer.MAX_VALUE - 1, 1000, 0f);
4141

4242
public static final String ID_PERSPECTIVE = "net.sourceforge.pmd.eclipse.ui.views.pmdPerspective";

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/builder/PMDBuilder.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ private void buildIncremental(IProject project, IProgressMonitor monitor) {
9898
if (resourceDelta != null && resourceDelta.getAffectedChildren().length != 0) {
9999
ReviewCodeCmd cmd = new ReviewCodeCmd();
100100
cmd.setResourceDelta(resourceDelta);
101-
cmd.setTaskMarker(false);
102101
cmd.setMonitor(monitor);
103102
// a builder is always asynchronous;
104103
// execute a command synchronously
@@ -118,7 +117,6 @@ private void buildIncremental(IProject project, IProgressMonitor monitor) {
118117
private void processProjectFiles(IProject project, IProgressMonitor monitor) {
119118
ReviewCodeCmd cmd = new ReviewCodeCmd();
120119
cmd.addResource(project);
121-
cmd.setTaskMarker(false);
122120
cmd.setMonitor(monitor);
123121
// a builder is always asynchronous; execute a command synchronously whatever its processor
124122
cmd.performExecute();

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/DetectCutAndPasteCmd.java

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
import net.sourceforge.pmd.cpd.Language;
3131
import net.sourceforge.pmd.cpd.LanguageFactory;
3232
import net.sourceforge.pmd.cpd.Match;
33-
import net.sourceforge.pmd.cpd.Renderer;
3433
import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
3534
import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
3635
import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
@@ -146,29 +145,25 @@ public void setMinTileSize(final int tilesize) {
146145
* @deprecated Use {@link #setCPDRenderer(CPDRenderer)} instead.
147146
*/
148147
@Deprecated
149-
public void setRenderer(final Renderer renderer) {
150-
if (renderer != null) {
148+
public void setRenderer(final net.sourceforge.pmd.cpd.Renderer theRenderer) {
149+
if (theRenderer != null) {
151150
this.setCPDRenderer(new CPDRenderer() {
152151
@Override
153152
public void render(Iterator<Match> matches, Writer writer) throws IOException {
154-
writer.write(renderer.render(matches));
153+
writer.write(theRenderer.render(matches));
155154
}
156155
});
157156
} else {
158157
this.setCPDRenderer(null);
159158
}
160159
}
161160

162-
public void setCPDRenderer(CPDRenderer renderer) {
163-
this.renderer = renderer;
161+
public void setCPDRenderer(CPDRenderer theRenderer) {
162+
this.renderer = theRenderer;
164163
}
165164

166-
/**
167-
* @param reportName
168-
* The reportName to set.
169-
*/
170-
public void setReportName(final String reportName) {
171-
this.reportName = reportName;
165+
public void setReportName(final String theReportName) {
166+
this.reportName = theReportName;
172167
}
173168

174169
/**

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/FakeRuleViolation.java

Lines changed: 69 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@
55
package net.sourceforge.pmd.eclipse.runtime.cmd;
66

77
import net.sourceforge.pmd.Rule;
8-
import net.sourceforge.pmd.RuleContext;
9-
import net.sourceforge.pmd.lang.ast.Node;
10-
import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
8+
import net.sourceforge.pmd.RuleViolation;
119

1210
/**
1311
* This is an implementation of IRuleViolation. It is meant to rebuild a
@@ -18,11 +16,21 @@
1816
* @author Brian Remedios
1917
*/
2018

21-
class FakeRuleViolation extends ParametricRuleViolation<Node> {
19+
class FakeRuleViolation implements RuleViolation {
20+
private int beginLine;
21+
private int beginColumn;
22+
private int endLine;
23+
private int endColumn;
2224

23-
private String description = "";
25+
private String filename;
26+
private String packageName;
27+
private String className;
28+
private String methodName;
29+
private String variableName;
30+
31+
private Rule rule;
2432

25-
private static final RuleContext DUMMY_CONTEXT = new RuleContext();
33+
private String description = "";
2634

2735
/**
2836
* Default constructor take a rule object to initialize. All other variables
@@ -31,7 +39,7 @@ class FakeRuleViolation extends ParametricRuleViolation<Node> {
3139
* @param rule
3240
*/
3341
FakeRuleViolation(Rule theRule) {
34-
super(theRule, DUMMY_CONTEXT, null, null);
42+
this.rule = theRule;
3543
}
3644

3745
@Override
@@ -119,4 +127,58 @@ public void setVariableName(String variableName) {
119127
this.variableName = variableName;
120128
}
121129

130+
@Override
131+
public Rule getRule() {
132+
return rule;
133+
}
134+
135+
@Override
136+
public boolean isSuppressed() {
137+
return false;
138+
}
139+
140+
@Override
141+
public String getFilename() {
142+
return filename;
143+
}
144+
145+
@Override
146+
public int getBeginLine() {
147+
return beginLine;
148+
}
149+
150+
@Override
151+
public int getBeginColumn() {
152+
return beginColumn;
153+
}
154+
155+
@Override
156+
public int getEndLine() {
157+
return endLine;
158+
}
159+
160+
@Override
161+
public int getEndColumn() {
162+
return endColumn;
163+
}
164+
165+
@Override
166+
public String getPackageName() {
167+
return packageName;
168+
}
169+
170+
@Override
171+
public String getClassName() {
172+
return className;
173+
}
174+
175+
@Override
176+
public String getMethodName() {
177+
return methodName;
178+
}
179+
180+
@Override
181+
public String getVariableName() {
182+
return variableName;
183+
}
122184
}

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewCodeCmd.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ public class ReviewCodeCmd extends AbstractDefaultCommand {
7575
private final List<IResource> resources = new ArrayList<>();
7676
private IResourceDelta resourceDelta;
7777
private Map<IFile, Set<MarkerInfo2>> markersByFile = new HashMap<>();
78-
private boolean taskMarker;
7978
private boolean openPmdPerspective;
8079
private boolean openPmdViolationsOverviewView;
8180
private boolean openPmdViolationsOutlineView;
@@ -407,8 +406,12 @@ public void setResourceDelta(IResourceDelta resourceDelta) {
407406
this.resourceDelta = resourceDelta;
408407
}
409408

409+
/**
410+
* @deprecated not used, never implemented
411+
*/
412+
@Deprecated
410413
public void setTaskMarker(boolean taskMarker) {
411-
this.taskMarker = taskMarker;
414+
// the flag was never used
412415
}
413416

414417
public void setRunAlways(boolean runAlways) {
@@ -538,9 +541,7 @@ private void processResource(IResource resource) {
538541
visitor.setMonitor(getMonitor());
539542
visitor.setRuleSetList(ruleSets);
540543
visitor.setFileExtensions(fileExtensions);
541-
// visitor.setPmdEngine(pmdEngine);
542544
visitor.setAccumulator(markersByFile);
543-
visitor.setUseTaskMarker(taskMarker);
544545
visitor.setProjectProperties(properties);
545546
resource.accept(visitor);
546547

@@ -712,9 +713,7 @@ private void processResourceDelta() {
712713
visitor.setMonitor(getMonitor());
713714
visitor.setRuleSetList(ruleSets);
714715
visitor.setFileExtensions(fileExtensions);
715-
// visitor.setPmdEngine(pmdEngine);
716716
visitor.setAccumulator(markersByFile);
717-
visitor.setUseTaskMarker(taskMarker);
718717
visitor.setProjectProperties(properties);
719718
resourceDelta.accept(visitor);
720719

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/properties/IProjectProperties.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
import org.eclipse.ui.IWorkingSet;
1313

1414
import net.sourceforge.pmd.RuleSet;
15-
import net.sourceforge.pmd.RuleSets;
1615

1716
/**
1817
* This interface specifies what is the model for the PMD related project
@@ -59,7 +58,7 @@ public interface IProjectProperties {
5958
* @deprecated Use {@link #setProjectRuleSetList(List)}
6059
*/
6160
@Deprecated
62-
void setProjectRuleSets(RuleSets projectRuleSets) throws PropertiesException;
61+
void setProjectRuleSets(net.sourceforge.pmd.RuleSets projectRuleSets) throws PropertiesException;
6362

6463
void setProjectRuleSetList(List<RuleSet> rulesets) throws PropertiesException;
6564

@@ -68,7 +67,7 @@ public interface IProjectProperties {
6867
* @deprecated Use {@link #getProjectRuleSetList()}
6968
*/
7069
@Deprecated
71-
RuleSets getProjectRuleSets() throws PropertiesException;
70+
net.sourceforge.pmd.RuleSets getProjectRuleSets() throws PropertiesException;
7271

7372
List<RuleSet> getProjectRuleSetList() throws PropertiesException;
7473

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/ClearReviewsAction.java

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
import java.io.StringWriter;
1313
import java.lang.reflect.InvocationTargetException;
1414
import java.util.Iterator;
15-
import java.util.Locale;
1615

1716
import org.eclipse.core.resources.IFile;
1817
import org.eclipse.core.resources.IFolder;
@@ -35,7 +34,6 @@
3534
import org.slf4j.LoggerFactory;
3635

3736
import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
38-
import net.sourceforge.pmd.eclipse.runtime.cmd.AbstractDefaultCommand;
3937
import net.sourceforge.pmd.eclipse.ui.nls.StringKeys;
4038

4139
/**
@@ -170,14 +168,6 @@ private void clearReviews(IFile file) {
170168
monitorWorked();
171169
}
172170

173-
private static boolean isReviewable(IFile file) {
174-
175-
if (AbstractDefaultCommand.isJavaFile(file)) {
176-
return true;
177-
}
178-
return file.getName().toLowerCase(Locale.ROOT).endsWith(".jsp");
179-
}
180-
181171
/**
182172
* remove reviews from file content
183173
*
@@ -186,10 +176,6 @@ private static boolean isReviewable(IFile file) {
186176
*/
187177
private String removeReviews(IFile file) {
188178

189-
if (!isReviewable(file)) {
190-
return null;
191-
}
192-
193179
StringWriter modified = new StringWriter();
194180
boolean noChange = true;
195181
try (BufferedReader reader = new BufferedReader(new InputStreamReader(file.getContents(), file.getCharset()));
@@ -200,7 +186,7 @@ private String removeReviews(IFile file) {
200186
String origLine = reader.readLine();
201187
String line = origLine.trim();
202188
if (line == null) {
203-
break;
189+
continue;
204190
}
205191
int index = origLine.indexOf(PMDRuntimeConstants.PMD_STYLE_REVIEW_COMMENT);
206192
int quoteIndex = origLine.indexOf('"');

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/PMDCheckAction.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ public void run(IAction action) {
5656
}
5757

5858
private void setupAndExecute(ReviewCodeCmd cmd) {
59-
cmd.setTaskMarker(true);
6059
cmd.setOpenPmdPerspective(PMDPlugin.getDefault().loadPreferences().isPmdPerspectiveEnabled());
6160
cmd.setOpenPmdViolationsOverviewView(PMDPlugin.getDefault().loadPreferences().isPmdViolationsOverviewEnabled());
6261
cmd.setOpenPmdViolationsOutlineView(PMDPlugin.getDefault().loadPreferences().isPmdViolationsOutlineEnabled());

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/ReviewCodeHandler.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,18 +108,18 @@ protected final void computeSelectedResources() {
108108
ISelection selection = getSelection();
109109
if (selection instanceof IStructuredSelection) {
110110
IStructuredSelection structuredSelection = (IStructuredSelection) selection;
111-
List resources = new ArrayList(structuredSelection.size());
111+
List<IResource> resources = new ArrayList<>(structuredSelection.size());
112112

113113
Iterator<?> e = structuredSelection.iterator();
114114
while (e.hasNext()) {
115115
Object element = e.next();
116116
if (element instanceof IResource) {
117-
resources.add(element);
117+
resources.add((IResource) element);
118118
} else if (element instanceof IAdaptable) {
119119
IAdaptable adaptable = (IAdaptable) element;
120120
Object adapter = adaptable.getAdapter(IResource.class);
121121
if (adapter instanceof IResource) {
122-
resources.add(adapter);
122+
resources.add((IResource) adapter);
123123
}
124124
}
125125
}

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/GeneralPreferencesPage.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public class GeneralPreferencesPage extends PreferencePage implements IWorkbench
9696
private Label logLevelValueLabel;
9797
private TableViewer tableViewer;
9898
private IPreferences preferences;
99-
private BasicTableManager priorityTableMgr;
99+
private BasicTableManager<?> priorityTableMgr;
100100
private Button determineFiletypesAutomatically;
101101

102102
private Control[] nameFields;
@@ -254,7 +254,7 @@ public Object[] getElements(Object inputElement) {
254254
};
255255
BasicTableLabelProvider labelProvider = new BasicTableLabelProvider(PriorityColumnUI.VISIBLE_COLUMNS);
256256

257-
priorityTableMgr = new BasicTableManager("prio", null, PriorityColumnUI.VISIBLE_COLUMNS);
257+
priorityTableMgr = new BasicTableManager<>("prio", null, PriorityColumnUI.VISIBLE_COLUMNS);
258258
tableViewer = priorityTableMgr.buildTableViewer(group);
259259
priorityTableMgr.setupColumns(PriorityColumnUI.VISIBLE_COLUMNS);
260260

0 commit comments

Comments
 (0)