spock.lang.AutoCleanup Maven / Gradle / Ivy

Go to download

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

Spock is a testing and specification framework for Java and Groovy applications. What makes it stand out from the crowd is its beautiful and highly expressive specification language. Thanks to its JUnit runner, Spock is compatible with most IDEs, build tools, and continuous integration servers. Spock is inspired from JUnit, jMock, RSpec, Groovy, Scala, Vulcans, and other fascinating life forms.

There is a newer version: 2.4-M4-groovy-4.0

Show newest version

/*
 * Copyright 2010 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *     https://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package spock.lang;

import java.lang.annotation.*;

import org.spockframework.runtime.extension.ExtensionAnnotation;
import org.spockframework.runtime.extension.builtin.AutoCleanupExtension;

/**
 * Automatically cleans up the object stored in the annotated field or property
 * at the end of its life time. More precisely, auto-cleanup of an object has
 * the same effect as, and serves as a convenient replacement for, calling the
 * object's close method at the end of the spec's cleanup method.
 * @Shared objects are cleaned up at the end of the spec's
 * cleanupSpec method.

 * Customizing how cleanup is performed
 * By default, an object is cleaned up by invoking its parameterless close()
 * method (which is assumed to exist); visibility and return type of this method
 * are irrelevant. If some other method should be called instead, override the
 * annotation's value attribute:
 *
 *  * @AutoCleanup("dispose") // invoke the object's "dispose" method
 * 
 *
 * Cleaning up multiple objects
 * If multiple fields or properties are annotated with @AutoCleanup,
 * their objects are cleaned up sequentially in reverse field/property declaration
 * order, starting from the most derived class and walking up the inheritance chain.
 *
 * Handling of exceptions during cleanup
 * If a cleanup operation fails with an exception, the exception is reported
 * (just as if it had occurred in a cleanup or cleanupSpec
 * method) and cleanup proceeds with the next annotated object. To prevent
 * cleanup exceptions from being reported, override the annotation's quiet
 * attribute:
 *
 *  * @AutoCleanup(quiet = true) // don't report exceptions
 * 
 *
 * @author Peter Niederwieser
 */
@ExtensionAnnotation(AutoCleanupExtension.class)
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface AutoCleanup {
  String value() default "close";
  boolean quiet() default false;
}