diff --git a/spring-aspects/src/main/java/org/springframework/mock/staticmock/AnnotationDrivenStaticEntityMockingControl.aj b/spring-aspects/src/main/java/org/springframework/mock/staticmock/AnnotationDrivenStaticEntityMockingControl.aj index 816f6a1e42..ade7c07a38 100644 --- a/spring-aspects/src/main/java/org/springframework/mock/staticmock/AnnotationDrivenStaticEntityMockingControl.aj +++ b/spring-aspects/src/main/java/org/springframework/mock/staticmock/AnnotationDrivenStaticEntityMockingControl.aj @@ -1,5 +1,5 @@ /* - * Copyright 2002-2013 the original author or authors. + * Copyright 2002-2014 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. @@ -17,29 +17,32 @@ package org.springframework.mock.staticmock; /** - * Annotation-based aspect to use in test build to enable mocking static methods - * on JPA-annotated {@code @Entity} classes, as used by Roo for finders. + * Annotation-based aspect to use in test builds to enable mocking static methods + * on JPA-annotated {@code @Entity} classes, as used by Spring Roo for finders. * *

Mocking will occur in the call stack of any method in a class (typically a test class) - * that is annotated with the @MockStaticEntityMethods annotation. + * that is annotated with the {@code @MockStaticEntityMethods} annotation. * *

Also provides static methods to simplify the programming model for * entering playback mode and setting expected return values. * *

Usage: *

    - *
  1. Annotate a test class with @MockStaticEntityMethods. - *
  2. In each test method, AnnotationDrivenStaticEntityMockingControl will begin in recording mode. - * Invoke static methods on Entity classes, with each recording-mode invocation - * being followed by an invocation to the static expectReturn() or expectThrow() - * method on AnnotationDrivenStaticEntityMockingControl. - *
  3. Invoke the static AnnotationDrivenStaticEntityMockingControl() method. - *
  4. Call the code you wish to test that uses the static methods. Verification will - * occur automatically. + *
  5. Annotate a test class with {@code @MockStaticEntityMethods}. + *
  6. In each test method, {@code AnnotationDrivenStaticEntityMockingControl} + * will begin in recording mode. + *
  7. Invoke static methods on JPA-annotated {@code @Entity} classes, with each + * recording-mode invocation being followed by an invocation of either the static + * {@link #expectReturn(Object)} method or the static {@link #expectThrow(Throwable)} + * method on {@code AnnotationDrivenStaticEntityMockingControl}. + *
  8. Invoke the static {@link #playback()} method. + *
  9. Call the code you wish to test that uses the static methods. + *
  10. Verification will occur automatically. *
* * @author Rod Johnson * @author Ramnivas Laddad + * @author Sam Brannen * @see MockStaticEntityMethods */ public aspect AnnotationDrivenStaticEntityMockingControl extends AbstractMethodMockingControl { diff --git a/spring-aspects/src/main/java/org/springframework/mock/staticmock/MockStaticEntityMethods.java b/spring-aspects/src/main/java/org/springframework/mock/staticmock/MockStaticEntityMethods.java index 913d147b3e..d6748f2117 100644 --- a/spring-aspects/src/main/java/org/springframework/mock/staticmock/MockStaticEntityMethods.java +++ b/spring-aspects/src/main/java/org/springframework/mock/staticmock/MockStaticEntityMethods.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2012 the original author or authors. + * Copyright 2002-2014 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. @@ -22,9 +22,10 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Annotation to indicate a test class for whose @Test methods - * static methods on Entity classes should be mocked. See - * {@code AbstractMethodMockingControl}. + * Annotation to indicate a test class for whose {code @Test} methods + * static methods on JPA-annotated {@code @Entity} classes should be mocked. + * + *

See {@code AnnotationDrivenStaticEntityMockingControl} for details. * * @author Rod Johnson */