spoon.reflect.code.CtTryWithResource 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.annotations.PropertyGetter;
import spoon.reflect.annotations.PropertySetter;

import java.util.List;

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

/**
 * This code element defines a try with resource statement.
 *
 * Example:
 *  *    // br is the resource
 *    try (java.io.BufferedReader br = new java.io.BufferedReader(new java.io.FileReader("/foo"))) {
 *    	br.readLine();
 *   }
 * 
 */
public interface CtTryWithResource extends CtTry {

	/**
	 * Gets the auto-closeable resources of this try. Available
	 * from Java 7 with the try-with-resource statement.
	 *
	 * The returned list is immutable for sake of proper encapsulation.
	 */
	@PropertyGetter(role = TRY_RESOURCE)
	List> getResources();

	/**
	 * Sets the auto-closeable resources of this try. Available
	 * from Java 7 with the try-with-resource statement.
	 */
	@PropertySetter(role = TRY_RESOURCE)
	 T setResources(List> resources);

	/**
	 * Adds a resource.
	 */
	@PropertySetter(role = TRY_RESOURCE)
	 T addResource(CtResource resource);

	/**
	 * Removes a resource.
	 */
	@PropertySetter(role = TRY_RESOURCE)
	boolean removeResource(CtResource resource);

	@Override
	CtTryWithResource clone();
}