spoon.reflect.declaration.CtMethod Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spoon-core Show documentation

Spoon is a tool for meta-programming, analysis and transformation of Java programs.

There is a newer version: 11.1.1-beta-14

/*
 * SPDX-License-Identifier: (MIT OR CECILL-C)
 *
 * Copyright (C) 2006-2023 INRIA and contributors
 *
 * Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) or the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
 */
package spoon.reflect.declaration;

import spoon.refactoring.Refactoring;
import spoon.reflect.annotations.PropertyGetter;
import spoon.reflect.annotations.PropertySetter;

import java.util.Collection;

import static spoon.reflect.path.CtRole.IS_DEFAULT;


/**
 * This element defines a method declaration.
 */
public interface CtMethod extends CtExecutable, CtFormalTypeDeclarer, CtShadowable {
	/**
	 * @param superMethod to be checked method
	 * @return true if this method overrides `superMethod`.

	 * Returns true for itself too.
	 * 	 * assertTrue(this.isOverriding(this))
	 * 
	 */
	boolean isOverriding(CtMethod superMethod);
	/**
	 * Checks if the method is a default method. Default method can be in interfaces from
	 * Java 8: http://docs.oracle.com/javase/tutorial/java/IandI/defaultmethods.html.
	 */
	@PropertyGetter(role = IS_DEFAULT)
	boolean isDefaultMethod();

	/**
	 * Sets the default value state of a method.
	 */
	@PropertySetter(role = IS_DEFAULT)
	> C setDefaultMethod(boolean defaultMethod);

	@Override
	CtMethod clone();

	/**
	 * Returns the top-most methods in the hierarchy defining this method
	 * (in super class and super interfaces).
	 * Returns the empty collection if defined here for the first time.
	 */
	Collection> getTopDefinitions();

	/**
	 * Copy the method, where copy means cloning + porting all the references of the old method to the new method (important for recursive methods).
	 * The copied method is added to the type, with a suffix "Copy".
	 *
	 * A new unique method name is given for each copy, and this method can be called several times.
	 *
	 * If you want to rename the new method, use {@link Refactoring#changeMethodName(CtMethod, String)} (and not {@link #setSimpleName(String)}, which does not update the references)
	 */
	CtMethod copyMethod();

}