spoon.reflect.declaration.CtNamedElement 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.reflect.reference.CtReference;
import spoon.support.DerivedProperty;
import spoon.reflect.annotations.PropertyGetter;
import spoon.reflect.annotations.PropertySetter;

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

/**
 * Declares an element that has a name (a class, a method, a variable, etc).
 * Hence, all subclasses of CtNamedElement are in package "declaration".
 * Note that references don't define elements, hence are not under CtNamedElement
 * even if they also have methods set/getSimpleName.
 */
public interface CtNamedElement extends CtElement {
	/**
	 * Returns the simple (unqualified) name of this element.
	 */
	@PropertyGetter(role = NAME)
	String getSimpleName();

	/**
	 * Sets the simple (unqualified) name of this element.
	 */
	@PropertySetter(role = NAME)
	 T setSimpleName(String simpleName);

	/**
	 * {@return the corresponding reference}
	 */
	@DerivedProperty
	CtReference getReference();

	@Override
	CtNamedElement clone();
}