/**

    Copyright 2007 Dan Oxlade

    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

        http://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.doxla.spring.automock.annotation;

 import java.lang.annotation.Documented;

 import java.lang.annotation.ElementType;

 import java.lang.annotation.Retention;

 import java.lang.annotation.RetentionPolicy;

 import java.lang.annotation.Target;

 /**

  * This annotation signals that the annotated type is subject to Automocking.

  * 

  * Developers should use this documentation level annotation to state that

  * the type is subject to Automocking and thus available in one or more

  * Spring application contexts associated with a testing framework.

  * It should also detail the name of the exposed Spring bean as a 

  * result of Automocking.

  * 

  * This will be useful when dealing with some of the implicit mock resolving

  * strategies such as the {@link InterfaceOnlyPatternMatchingMockResolver} 

  * where it is not imediately obvious as to where the injected {@link Mock} or

  * indeed proxy is registered with Spring.

  * 

  * For instance if you are using the AutoMock framework with the 

  * {@link DefaultProxyMockNameResolver} then your mockName attribute 

  * will typically be 'mock[Type]' where [Type] is replaced with the

  * class name of the Type this annotation targets.

  * 

  * For an example @see {@link SimpleTestService}

  *  

  * @author danoxlade

  */

 @Documented

 @Retention(RetentionPolicy.SOURCE)

 @Target(ElementType.TYPE)

 public @interface AutoMocked {

         String mockName();

 }