1 /*******************************************************************************
2  * Copyright (c) 2000, 2019 IBM Corporation and others.
3  *
4  * This program and the accompanying materials
5  * are made available under the terms of the Eclipse Public License 2.0
6  * which accompanies this distribution, and is available at
7  * https://www.eclipse.org/legal/epl-2.0/
8  *
9  * SPDX-License-Identifier: EPL-2.0
10  *
11  * Contributors:
12  *     IBM Corporation - initial API and implementation
13  *     Red Hat Inc. - modified to use PotentialProgrammingProblemsFixCore
14  *******************************************************************************/
15 package org.eclipse.jdt.internal.corext.fix;
16 
17 import java.util.ArrayList;
18 import java.util.List;
19 
20 import org.eclipse.core.runtime.CoreException;
21 import org.eclipse.core.runtime.IProgressMonitor;
22 
23 import org.eclipse.ltk.core.refactoring.RefactoringStatus;
24 
25 import org.eclipse.jdt.core.ICompilationUnit;
26 import org.eclipse.jdt.core.IJavaProject;
27 import org.eclipse.jdt.core.compiler.IProblem;
28 import org.eclipse.jdt.core.dom.ASTNode;
29 import org.eclipse.jdt.core.dom.CompilationUnit;
30 import org.eclipse.jdt.core.dom.ITypeBinding;
31 import org.eclipse.jdt.core.dom.SimpleName;
32 
33 import org.eclipse.jdt.ui.cleanup.ICleanUpFix;
34 import org.eclipse.jdt.ui.text.java.IProblemLocation;
35 
36 import org.eclipse.jdt.internal.ui.text.correction.ProblemLocation;
37 import org.eclipse.jdt.internal.ui.text.correction.ProblemLocationCore;
38 import org.eclipse.jdt.internal.ui.text.correction.SerialVersionHashOperationCore;
39 
40 
41 public class PotentialProgrammingProblemsFix extends CompilationUnitRewriteOperationsFix {
42 
43 	private static PotentialProgrammingProblemsFixCore.ISerialVersionFixContext fCurrentContext;
44 
createMissingSerialVersionFixes(CompilationUnit compilationUnit, IProblemLocation problem)45 	public static IProposableFix[] createMissingSerialVersionFixes(CompilationUnit compilationUnit, IProblemLocation problem) {
46 		if (problem.getProblemId() != IProblem.MissingSerialVersion)
47 			return null;
48 
49 		final ICompilationUnit unit= (ICompilationUnit)compilationUnit.getJavaElement();
50 		if (unit == null)
51 			return null;
52 
53 		final SimpleName simpleName= PotentialProgrammingProblemsFixCore.getSelectedName(compilationUnit, (ProblemLocationCore)problem);
54 		if (simpleName == null)
55 			return null;
56 
57 		ASTNode declaringNode= PotentialProgrammingProblemsFixCore.getDeclarationNode(simpleName);
58 		if (declaringNode == null)
59 			return null;
60 
61 		SerialVersionDefaultOperationCore defop= new SerialVersionDefaultOperationCore(unit, new ASTNode[] {declaringNode});
62 		IProposableFix fix1= new PotentialProgrammingProblemsFix(FixMessages.Java50Fix_SerialVersion_default_description, compilationUnit, new CompilationUnitRewriteOperationsFixCore.CompilationUnitRewriteOperation[] {defop});
63 
64 		SerialVersionHashOperationCore hashop= new SerialVersionHashOperationCore(unit, new ASTNode[] {declaringNode});
65 		IProposableFix fix2= new PotentialProgrammingProblemsFix(FixMessages.Java50Fix_SerialVersion_hash_description, compilationUnit, new CompilationUnitRewriteOperationsFixCore.CompilationUnitRewriteOperation[] {hashop});
66 
67 		return new IProposableFix[] {fix1, fix2};
68 	}
69 
checkPreConditions(IJavaProject project, ICompilationUnit[] compilationUnits, IProgressMonitor monitor, boolean calculatedId, boolean defaultId, boolean randomId)70 	public static RefactoringStatus checkPreConditions(IJavaProject project, ICompilationUnit[] compilationUnits, IProgressMonitor monitor,
71 			boolean calculatedId,
72 			boolean defaultId,
73 			boolean randomId) throws CoreException {
74 
75 		return PotentialProgrammingProblemsFixCore.checkPreConditions(project, compilationUnits, monitor, calculatedId, defaultId, randomId);
76     }
77 
checkPostConditions(IProgressMonitor monitor)78 	public static RefactoringStatus checkPostConditions(IProgressMonitor monitor) {
79 		return PotentialProgrammingProblemsFixCore.checkPostConditions(monitor);
80    }
81 
createCleanUp(CompilationUnit compilationUnit, boolean addSerialVersionIds)82 	public static ICleanUpFix createCleanUp(CompilationUnit compilationUnit, boolean addSerialVersionIds) {
83 
84 		IProblem[] problems= compilationUnit.getProblems();
85 		IProblemLocation[] locations= new IProblemLocation[problems.length];
86 		for (int i= 0; i < problems.length; i++) {
87 			locations[i]= new ProblemLocation(problems[i]);
88 		}
89 		return createCleanUp(compilationUnit, locations, addSerialVersionIds);
90 	}
91 
createCleanUp(CompilationUnit compilationUnit, IProblemLocation[] problems, boolean addSerialVersionIds)92 	public static ICleanUpFix createCleanUp(CompilationUnit compilationUnit, IProblemLocation[] problems, boolean addSerialVersionIds) {
93 		if (addSerialVersionIds) {
94 
95 			final ICompilationUnit unit= (ICompilationUnit)compilationUnit.getJavaElement();
96 			if (unit == null)
97 				return null;
98 
99 			List<ASTNode> declarationNodes= new ArrayList<>();
100 			for (IProblemLocation problem : problems) {
101 				if (problem.getProblemId() == IProblem.MissingSerialVersion) {
102 					final SimpleName simpleName= PotentialProgrammingProblemsFixCore.getSelectedName(compilationUnit, (ProblemLocationCore)problem);
103 					if (simpleName != null) {
104 						ASTNode declarationNode= PotentialProgrammingProblemsFixCore.getDeclarationNode(simpleName);
105 						if (declarationNode != null) {
106 							declarationNodes.add(declarationNode);
107 						}
108 					}
109 				}
110 			}
111 			if (declarationNodes.isEmpty())
112 				return null;
113 
114 			for (ASTNode declarationNode : declarationNodes) {
115 	            ITypeBinding binding= PotentialProgrammingProblemsFixCore.getTypeBinding(declarationNode);
116 	            if (fCurrentContext.getSerialVersionId(binding) != null) {
117 	            	PotentialProgrammingProblemsFixCore.SerialVersionHashBatchOperation op= new PotentialProgrammingProblemsFixCore.SerialVersionHashBatchOperation(unit, declarationNodes.toArray(new ASTNode[declarationNodes.size()]), fCurrentContext);
118 	    			return new PotentialProgrammingProblemsFix(FixMessages.PotentialProgrammingProblemsFix_add_id_change_name, compilationUnit, new CompilationUnitRewriteOperationsFixCore.CompilationUnitRewriteOperation[] {op});
119 	            }
120             }
121 		}
122 		return null;
123 	}
124 
PotentialProgrammingProblemsFix(String name, CompilationUnit compilationUnit, CompilationUnitRewriteOperationsFixCore.CompilationUnitRewriteOperation[] fixRewriteOperations)125 	protected PotentialProgrammingProblemsFix(String name, CompilationUnit compilationUnit, CompilationUnitRewriteOperationsFixCore.CompilationUnitRewriteOperation[] fixRewriteOperations) {
126 		super(name, compilationUnit, fixRewriteOperations);
127 	}
128 }