spoon.reflect.code.CtCatchVariable 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.code;

import spoon.reflect.declaration.CtMultiTypedElement;
import spoon.reflect.declaration.CtTypedElement;
import spoon.reflect.declaration.CtVariable;
import spoon.reflect.reference.CtCatchVariableReference;
import spoon.reflect.reference.CtTypeReference;
import spoon.support.DerivedProperty;
import spoon.support.UnsettableProperty;

/**
 * This code element defines an exception variable in a catch.
 *
 * @param 
 * 		type of the variable
 */
public interface CtCatchVariable extends CtVariable, CtMultiTypedElement, CtCodeElement {

	/*
	 * (non-Javadoc)
	 *
	 * @see spoon.reflect.declaration.CtNamedElement#getReference()
	 */
	@Override
	@DerivedProperty
	CtCatchVariableReference getReference();

	@Override
	CtCatchVariable clone();

	@Override
	@UnsettableProperty
	> C setDefaultExpression(CtExpression assignedExpression);

	/**
	 * {@return whether this catch variable is unnamed}
	 */
	@DerivedProperty
	boolean isUnnamed();

	/**
	 * Returns type reference of the exception variable in a catch.
	 * If type is unknown, or any of the types in a multi-catch is unknown, returns null.
	 */
	@Override
	@DerivedProperty
	CtTypeReference getType();

	@Override
	@UnsettableProperty
	 C setType(CtTypeReference type);
}