com.liferay.source.formatter.checkstyle.check.UpgradeDeprecatedAPICheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.source.formatter
Liferay Source Formatter
The newest version!
/**
 * SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
 * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
 */

package com.liferay.source.formatter.checkstyle.check;

import com.liferay.portal.kernel.json.JSONObject;
import com.liferay.source.formatter.util.SourceFormatterUtil;

import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.AnnotationUtil;

import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * @author Hugo Huijser
 */
public class UpgradeDeprecatedAPICheck extends DeprecatedAPICheck {

	@Override
	public int[] getDefaultTokens() {
		return new int[] {
			TokenTypes.CLASS_DEF, TokenTypes.ENUM_DEF, TokenTypes.INTERFACE_DEF
		};
	}

	@Override
	protected void doVisitToken(DetailAST detailAST) {
		DetailAST parentDetailAST = detailAST.getParent();

		if ((parentDetailAST != null) ||
			AnnotationUtil.containsAnnotation(detailAST, "Deprecated")) {

			return;
		}

		String upgradeFromVersion = getAttributeValue(
			SourceFormatterUtil.UPGRADE_FROM_VERSION);
		String upgradeToVersion = getAttributeValue(
			SourceFormatterUtil.UPGRADE_TO_RELEASE_VERSION);

		try {
			JSONObject upgradeFromJavaClassesJSONObject =
				getJavaClassesJSONObject(upgradeFromVersion);
			JSONObject upgradeToJavaClassesJSONObject =
				getJavaClassesJSONObject(upgradeToVersion);

			List upgradeFromDeprecatedImportNames =
				getDeprecatedImportNames(
					detailAST, upgradeFromJavaClassesJSONObject);
			List upgradeToDeprecatedImportNames =
				getDeprecatedImportNames(
					detailAST, upgradeToJavaClassesJSONObject);

			for (String upgradeToDeprecatedImportName :
					upgradeToDeprecatedImportNames) {

				if (!upgradeFromDeprecatedImportNames.contains(
						upgradeToDeprecatedImportName) &&
					hasUndeprecatedReference(
						detailAST, upgradeToDeprecatedImportName)) {

					log(
						getImportLineNumber(
							detailAST, upgradeToDeprecatedImportName),
						_MSG_DEPRECATED_TYPE_CALL,
						upgradeToDeprecatedImportName, upgradeToVersion);
				}
			}

			_checkDeprecatedConstructors(
				detailAST, upgradeFromDeprecatedImportNames,
				upgradeFromJavaClassesJSONObject,
				upgradeToDeprecatedImportNames, upgradeToJavaClassesJSONObject,
				upgradeToVersion);
			_checkDeprecatedMethods(
				detailAST, upgradeFromDeprecatedImportNames,
				upgradeFromJavaClassesJSONObject,
				upgradeToDeprecatedImportNames, upgradeToJavaClassesJSONObject,
				upgradeToVersion);
			_checkDeprecatedTypes(
				detailAST, upgradeFromDeprecatedImportNames,
				upgradeFromJavaClassesJSONObject,
				upgradeToDeprecatedImportNames, upgradeToJavaClassesJSONObject,
				upgradeToVersion);
			_checkDeprecatedVariables(
				detailAST, upgradeFromDeprecatedImportNames,
				upgradeFromJavaClassesJSONObject,
				upgradeToDeprecatedImportNames, upgradeToJavaClassesJSONObject,
				upgradeToVersion);
		}
		catch (Exception exception) {
		}
	}

	private void _checkDeprecatedConstructors(
		DetailAST detailAST, List upgradeFromDeprecatedImportNames,
		JSONObject upgradeFromJavaClassesJSONObject,
		List upgradeToDeprecatedImportNames,
		JSONObject upgradeToJavaClassesJSONObject, String upgradeToVersion) {

		List upgradeFromDeprecatedConstructorCalls =
			getDeprecatedConstructorCalls(
				detailAST, upgradeFromDeprecatedImportNames,
				upgradeFromJavaClassesJSONObject);
		List upgradeToDeprecatedConstructorCalls =
			getDeprecatedConstructorCalls(
				detailAST, upgradeToDeprecatedImportNames,
				upgradeToJavaClassesJSONObject);

		for (ConstructorCall upgradeToDeprecatedConstructorCall :
				upgradeToDeprecatedConstructorCalls) {

			if (!upgradeFromDeprecatedConstructorCalls.contains(
					upgradeToDeprecatedConstructorCall)) {

				log(
					upgradeToDeprecatedConstructorCall.getLineNumber(),
					_MSG_DEPRECATED_CONSTRUCTOR_CALL,
					upgradeToDeprecatedConstructorCall.getTypeName(),
					upgradeToVersion);
			}
		}
	}

	private void _checkDeprecatedMethods(
		DetailAST detailAST, List upgradeFromDeprecatedImportNames,
		JSONObject upgradeFromJavaClassesJSONObject,
		List upgradeToDeprecatedImportNames,
		JSONObject upgradeToJavaClassesJSONObject, String upgradeToVersion) {

		List upgradeFromDeprecatedMethodCalls =
			getDeprecatedMethodCalls(
				detailAST, upgradeFromDeprecatedImportNames,
				upgradeFromJavaClassesJSONObject);
		List upgradeToDeprecatedMethodCalls =
			getDeprecatedMethodCalls(
				detailAST, upgradeToDeprecatedImportNames,
				upgradeToJavaClassesJSONObject);

		for (MethodCall upgradeToDeprecatedMethodCall :
				upgradeToDeprecatedMethodCalls) {

			if (!upgradeFromDeprecatedMethodCalls.contains(
					upgradeToDeprecatedMethodCall)) {

				log(
					upgradeToDeprecatedMethodCall.getLineNumber(),
					_MSG_DEPRECATED_METHOD_CALL,
					upgradeToDeprecatedMethodCall.getName(), upgradeToVersion);
			}
		}
	}

	private void _checkDeprecatedTypes(
		DetailAST detailAST, List upgradeFromDeprecatedImportNames,
		JSONObject upgradeFromJavaClassesJSONObject,
		List upgradeToDeprecatedImportNames,
		JSONObject upgradeToJavaClassesJSONObject, String upgradeToVersion) {

		Map> upgradeFromDeprecatedTypeNamesMap =
			getDeprecatedTypeNamesMap(
				detailAST, upgradeFromDeprecatedImportNames,
				upgradeFromJavaClassesJSONObject);
		Map> upgradeToDeprecatedTypeNamesMap =
			getDeprecatedTypeNamesMap(
				detailAST, upgradeToDeprecatedImportNames,
				upgradeToJavaClassesJSONObject);

		for (Map.Entry> entry :
				upgradeToDeprecatedTypeNamesMap.entrySet()) {

			String upgradeToTypeName = entry.getKey();

			if (!upgradeFromDeprecatedTypeNamesMap.containsKey(
					upgradeToTypeName)) {

				continue;
			}

			Set upgradeToLineNumbers = entry.getValue();

			for (int upgradeToLineNumber : upgradeToLineNumbers) {
				log(
					upgradeToLineNumber, _MSG_DEPRECATED_TYPE_CALL,
					upgradeToTypeName, upgradeToVersion);
			}
		}
	}

	private void _checkDeprecatedVariables(
		DetailAST detailAST, List upgradeFromDeprecatedImportNames,
		JSONObject upgradeFromJavaClassesJSONObject,
		List upgradeToDeprecatedImportNames,
		JSONObject upgradeToJavaClassesJSONObject, String upgradeToVersion) {

		List upgradeFromDeprecatedVariableCalls =
			getDeprecatedVariableCalls(
				detailAST, upgradeFromDeprecatedImportNames,
				upgradeFromJavaClassesJSONObject);
		List upgradeToDeprecatedVariableCalls =
			getDeprecatedVariableCalls(
				detailAST, upgradeToDeprecatedImportNames,
				upgradeToJavaClassesJSONObject);

		for (VariableCall upgradeToDeprecatedVariableCall :
				upgradeToDeprecatedVariableCalls) {

			if (!upgradeFromDeprecatedVariableCalls.contains(
					upgradeToDeprecatedVariableCall)) {

				log(
					upgradeToDeprecatedVariableCall.getLineNumber(),
					_MSG_DEPRECATED_FIELD_CALL,
					upgradeToDeprecatedVariableCall.getName(),
					upgradeToVersion);
			}
		}
	}

	private static final String _MSG_DEPRECATED_CONSTRUCTOR_CALL =
		"constructor.call.deprecated";

	private static final String _MSG_DEPRECATED_FIELD_CALL =
		"field.call.deprecated";

	private static final String _MSG_DEPRECATED_METHOD_CALL =
		"method.call.deprecated";

	private static final String _MSG_DEPRECATED_TYPE_CALL =
		"type.call.deprecated";

}