package biz.xsoftware.mock;

 import java.lang.annotation.ElementType;

 import java.lang.annotation.Retention;

 import java.lang.annotation.RetentionPolicy;

 import java.lang.annotation.Target;

 /**

  * This annotation is used to annotate a method inside a {@link Behavior} class

  * as implementing an interface method in the {@link MockObject}. We'll give a

  * basic example on how to use this annotation. First we'll need an interface

  * that will need to be mocked:

  * 

  * <pre>

  * public interface MyInterface {

  *     public String myMethod();

  * }

  * </pre>

  * 

  * Here is the example Behavior implementation with myMethod annotated as a

  * BehaviorMethod:

  * 

  * <pre>

  * public class MyBehavior implements Behavior {

  *     @BehaviorMethod

  *     public String myMethod() {

  *         return "This is the desired behavior";

  *     }

  * }

  * </pre>

  * 

  * Here is the example of using the Behavior with a MockObject:

  * 

  * <pre>

  * public class Example {

  *     public static void main(String... args) {

  *         MockObject myInterface = MockObjectFactory.createMock(MyInterface.class);

  *         myInterface.setBehavior(new MyBehavior());

  *         System.out.println(((MyInterface) myInterface).myMethod());

  *     }

  * }

  * </pre>

  * 

  * When this example is run "This is the desired behavior" will be printed to

  * console.

  * 

  * @author Brian Freeman

  */

 @Retention(RetentionPolicy.RUNTIME)

 @Target(ElementType.METHOD)

 public @interface BehaviorMethod {

     Class<?> override() default void.class;

 }