org.spockframework.spring.StubBeans Maven / Gradle / Ivy

Go to download

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

Spock's Spring Module makes it possible to use Spring's TestContext framework together with Spock. Supports Spring 2.5.x, 3.x, and 4.x.

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

Show newest version

/*
 * Copyright 2018 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 org.spockframework.spring;

import org.spockframework.util.Beta;

import java.lang.annotation.*;

/**
 * Adds one or more plain Stubs to the ApplicationContext.
 *
 * Use this if you just need to satisfy some dependencies without
 * actually doing anything with these stubs.
 * 
 * If you need to control the stubs, e.g., configure return values
 * then use {@link SpringBean} instead.
 * 

 * Like {@link SpringBean} {@link StubBeans} also replaced existing BeanDefinitions,
 * so you can use it to remove real beans from an ApplicationContext.
 * 
 * {@link StubBeans} can be replaced by {@link SpringBean}, this can be useful
 * if you need to replace some {@link StubBeans} defined in a parent class.
 *
 * @author Leonard Brünings
 * @since 1.2
 */
@Beta
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface StubBeans {
  /**
   * List of classes to stub
   * @return classes to stub
   */
  Class[] value();

  /**
   * Controls if parent StubBean declarations should be inherited.
   *
   * @return true if inherit false if only this one
   */
  boolean inherit() default true;
}