com.liferay.source.formatter.checks.JavaSignatureParametersCheck Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com.liferay.source.formatter
Liferay Source Formatter
There is a newer version: 1.0.1437
/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.source.formatter.checks;

import com.liferay.petra.string.StringBundler;
import com.liferay.source.formatter.parser.JavaParameter;
import com.liferay.source.formatter.parser.JavaSignature;
import com.liferay.source.formatter.parser.JavaTerm;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author Hugo Huijser
 */
public class JavaSignatureParametersCheck extends BaseJavaTermCheck {

	@Override
	public boolean isLiferaySourceCheck() {
		return true;
	}

	@Override
	protected String doProcess(
		String fileName, String absolutePath, JavaTerm javaTerm,
		String fileContent) {

		if (javaTerm.hasAnnotation("Deprecated")) {
			return javaTerm.getContent();
		}

		JavaSignature signature = javaTerm.getSignature();

		List parameters = signature.getParameters();

		if (parameters.size() > 1) {
			_checkParameterOrder(
				fileName, parameters, javaTerm.getLineNumber(),
				"HttpServletRequest", "HttpServletResponse",
				"LiferayPortletRequest", "LiferayPortletResponse",
				"RenderRequest", "RenderResponse");
			_checkParameterOrder(
				fileName, parameters, javaTerm.getLineNumber(),
				"PortletRequest", "PortletResponse");
		}

		return javaTerm.getContent();
	}

	@Override
	protected String[] getCheckableJavaTermNames() {
		return new String[] {JAVA_CONSTRUCTOR, JAVA_METHOD};
	}

	private void _checkParameterOrder(
		String fileName, List parameters, int lineNumber,
		String... typeNames) {

		Map indexMap = new HashMap<>();

		for (String typeName : typeNames) {
			for (int i = 0; i < parameters.size(); i++) {
				JavaParameter javaParameter = parameters.get(i);

				if (!typeName.equals(javaParameter.getParameterType())) {
					continue;
				}

				for (Map.Entry entry : indexMap.entrySet()) {
					if (i < entry.getValue()) {
						addMessage(
							fileName,
							StringBundler.concat(
								"Parameter of type '", entry.getKey(),
								"' should come before parameter of type '",
								typeName, "'"),
							lineNumber);
					}
				}

				indexMap.put(typeName, i);
			}
		}
	}

}