spoon.reflect.declaration.CtModifiable 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.annotations.PropertyGetter;
import spoon.reflect.annotations.PropertySetter;
import spoon.support.DerivedProperty;
import spoon.support.reflect.CtExtendedModifier;

import java.util.Set;

import static spoon.reflect.path.CtRole.EMODIFIER;
import static spoon.reflect.path.CtRole.MODIFIER;

/**
 * This interface defines an element that accepts modifiers.
 */
public interface CtModifiable extends CtElement {
	/**
	 * Returns the modifiers of this element, excluding annotations. Implicit
	 * modifiers, such as the {@code public} and {@code static} modifiers of
	 * interface members, are included.
	 *
	 * @return the modifiers of this declaration in undefined order; an empty
	 * set if there are none
	 */
	@PropertyGetter(role = MODIFIER)
	Set getModifiers();

	/**
	 * Tells if this element contains the given modifier.
	 *
	 * @param modifier
	 * 		to search
	 * @return {@code true} if this element contain the modifier
	 */
	boolean hasModifier(ModifierKind modifier);

	/**
	 * Sets the modifiers.
	 */
	@PropertySetter(role = MODIFIER)
	 T setModifiers(Set modifiers);

	/**
	 * add a modifier
	 *
	 * @param modifier
	 */
	@PropertySetter(role = MODIFIER)
	 T addModifier(ModifierKind modifier);

	/**
	 * remove a modifier
	 *
	 * @param modifier
	 */
	@PropertySetter(role = MODIFIER)
	 T removeModifier(ModifierKind modifier);

	/**
	 * Sets the visibility of this modifiable element (replaces old visibility).
	 */
	@PropertySetter(role = MODIFIER)
	 T setVisibility(ModifierKind visibility);

	/**
	 * Gets the visibility of this modifiable element.
	 */
	@DerivedProperty
	ModifierKind getVisibility();

	/**
	 * @return the set of extended modifiers (those incl. implicit).
	 */
	@PropertyGetter(role = EMODIFIER)
	Set getExtendedModifiers();
	 T setExtendedModifiers(Set extendedModifiers);

	/**
	 * Returns true if it contains a public modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isPublic();

	/**
	 * Returns true if it contains a final modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isFinal();

	/**
	 * Returns true if it contains a static modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isStatic();

	/**
	 * Returns true if it contains a protected modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isProtected();

	/**
	 * Returns true if it contains a private modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isPrivate();

	/**
	 * Returns true if it contains an abstract modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isAbstract();

	/**
	 * Returns true if it contains a transient modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isTransient();

	/**
	 * Returns true if it contains a volatile modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isVolatile();

	/**
	 * Returns true if it contains a synchronized modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isSynchronized();

	/**
	 * Returns true if it contains a native modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isNative();

	/**
	 * Returns true if it contains a strictfp modifier (see {@link #hasModifier(ModifierKind)})
	 */
	@DerivedProperty
	boolean isStrictfp();
}