com.liferay.source.formatter.checkstyle.check.ExceptionCheck 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.petra.string.StringBundler;
import com.liferay.petra.string.StringPool;

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

import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * @author Hugo Huijser
 */
public class ExceptionCheck extends BaseCheck {

	@Override
	public int[] getDefaultTokens() {
		return new int[] {TokenTypes.METHOD_DEF};
	}

	@Override
	protected void doVisitToken(DetailAST detailAST) {
		DetailAST modifiersDetailAST = detailAST.findFirstToken(
			TokenTypes.MODIFIERS);

		if ((modifiersDetailAST == null) ||
			!modifiersDetailAST.branchContains(TokenTypes.LITERAL_PRIVATE)) {

			return;
		}

		List exceptionNames = _getExceptionNames(detailAST);

		if (exceptionNames.isEmpty() || exceptionNames.contains("Exception")) {
			return;
		}

		_checkException(detailAST, exceptionNames);
	}

	private void _checkException(
		DetailAST methodDefinitionDetailAST, List exceptionNames) {

		DetailAST classDefinitionDetailAST = null;
		DetailAST parentDetailAST = methodDefinitionDetailAST;

		while (true) {
			parentDetailAST = getParentWithTokenType(
				parentDetailAST, TokenTypes.CLASS_DEF,
				TokenTypes.INTERFACE_DEF);

			if (parentDetailAST == null) {
				break;
			}

			classDefinitionDetailAST = parentDetailAST;
		}

		if (classDefinitionDetailAST == null) {
			return;
		}

		String methodName = getName(methodDefinitionDetailAST);

		List identDetailASTList = getAllChildTokens(
			classDefinitionDetailAST, true, TokenTypes.IDENT);

		boolean calledByMethodWithException = false;

		for (DetailAST identDetailAST : identDetailASTList) {
			if (!methodName.equals(identDetailAST.getText())) {
				continue;
			}

			parentDetailAST = getParentWithTokenType(
				identDetailAST, TokenTypes.LAMBDA, TokenTypes.LITERAL_TRY,
				TokenTypes.METHOD_REF);

			if (parentDetailAST != null) {
				return;
			}

			parentDetailAST = getParentWithTokenType(
				identDetailAST, TokenTypes.CTOR_DEF, TokenTypes.METHOD_DEF);

			if (parentDetailAST == null) {
				return;
			}

			DetailAST nameDetailAST = parentDetailAST.findFirstToken(
				TokenTypes.IDENT);

			if (methodName.equals(nameDetailAST.getText())) {
				continue;
			}

			List methodExceptionNames = _getExceptionNames(
				parentDetailAST);

			if (methodExceptionNames.isEmpty()) {
				continue;
			}

			if ((methodExceptionNames.size() == 1) &&
				Objects.equals(methodExceptionNames.get(0), "Exception")) {

				calledByMethodWithException = true;

				continue;
			}

			return;
		}

		if (calledByMethodWithException) {
			log(
				methodDefinitionDetailAST, _MSG_UNNECESSARY_EXCEPTION,
				methodName, _getExceptionNamesString(exceptionNames));
		}
	}

	private List _getExceptionNames(DetailAST detailAST) {
		DetailAST literalThrowsDetailAST = detailAST.findFirstToken(
			TokenTypes.LITERAL_THROWS);

		if (literalThrowsDetailAST == null) {
			return Collections.emptyList();
		}

		return getNames(literalThrowsDetailAST, false);
	}

	private String _getExceptionNamesString(List exceptionNames) {
		StringBundler sb = new StringBundler();

		for (int i = 0; i < exceptionNames.size(); i++) {
			sb.append(StringPool.APOSTROPHE);
			sb.append(exceptionNames.get(i));
			sb.append(StringPool.APOSTROPHE);

			if (i < (exceptionNames.size() - 2)) {
				sb.append(StringPool.COMMA_AND_SPACE);
			}
			else if (i < (exceptionNames.size() - 1)) {
				sb.append(" and ");
			}
		}

		return sb.toString();
	}

	private static final String _MSG_UNNECESSARY_EXCEPTION =
		"exception.unnecessary";

}