com.sap.psr.vulas.java.JavaMethodId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lang-java Show documentation
There is a newer version: 3.1.15
/**
 * This file is part of Eclipse Steady.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright (c) 2018 SAP SE or an SAP affiliate company. All rights reserved.
 */
package com.sap.psr.vulas.java;

import java.util.List;

import com.sap.psr.vulas.ConstructId;


/**
 * Identifies a method relative to its class (normal or nested).
 */
public class JavaMethodId extends JavaId {

	private JavaId context = null;
	private String methodId = null;
	private List parameterTypes = null;

	/**
	 * Constructor for JavaMethodId.
	 *
	 * @param _c a {@link com.sap.psr.vulas.java.JavaId} object.
	 * @param _simple_name a {@link java.lang.String} object.
	 * @param _parameter_types a {@link java.util.List} object.
	 */
	public JavaMethodId(JavaId _c, String _simple_name, List _parameter_types) {
		super(JavaId.Type.METHOD);
		this.context = _c;
		this.methodId = _simple_name;
		this.parameterTypes = _parameter_types;
	}
	
	/**
	 * Returns the fully qualified name, i.e., with parameter types and the surrounding class.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getQualifiedName() { return context.getQualifiedName() + "." + this.methodId + JavaId.parameterTypesToString(this.parameterTypes, true); }

	/**
	 * Returns the method name, including parameter types in brackets.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getName() { return this.methodId + JavaId.parameterTypesToString(this.parameterTypes, true); }

	/**
	 * Returns the method name, excluding parameter types and brackets.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getSimpleName() { return this.methodId; }
	
	/**
	 * getDefinitionContext.
	 *
	 * @return a {@link com.sap.psr.vulas.ConstructId} object.
	 */
	public ConstructId getDefinitionContext() { return this.context; }
	
	/**
	 * getJavaPackageId.
	 *
	 * @return a {@link com.sap.psr.vulas.java.JavaPackageId} object.
	 */
	public JavaPackageId getJavaPackageId() { return this.context.getJavaPackageId(); }
	
	/**
	 * Returns true if the method has the @Test annotation or both the method name and its class name have the postfix or suffix 'test'.
	 *
	 * @return a boolean.
	 */
	public boolean isTestMethod() {
		boolean is_test = this.hasAnnotation("Test");
		
		// @Test annotation not found, let's check the qualified names of the class context and the method itself
		if(!is_test && this.context.getType().equals(JavaId.Type.CLASS)) {
			is_test = ((JavaClassId)this.context).isTestClass() && (this.methodId.toLowerCase().startsWith("test") || this.methodId.toLowerCase().endsWith("test"));
		}
		
		return is_test;
	}
}