Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish Javadoc for @IfProfileValue

Browse Source
This commit is contained in:
Sam Brannen
2013-11-25 21:22:54 -05:00
parent 412f74f679
commit a5d87fffd9
1 changed files with 16 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
spring-test/src/main/java/org/springframework/test/annotation/IfProfileValue.java
View File

@@ -27,21 +27,22 @@ import java.lang.annotation.Target;
* <p> * <p>
* Test annotation to indicate that a test is enabled for a specific testing * Test annotation to indicate that a test is enabled for a specific testing
* profile or environment. If the configured {@link ProfileValueSource} returns * profile or environment. If the configured {@link ProfileValueSource} returns
* a matching {@link #value() value} for the provided {@link #name() name}, the * a matching {@link #value} for the provided {@link #name}, the test will be
* test will be enabled. * enabled.
* </p> * </p>
* <p> * <p>
* Note: {@code &#064;IfProfileValue} can be applied at the class level, * Note: {@code @IfProfileValue} can be applied at the class level, the method
* the method level, or both. {@code &#064;IfProfileValue} at the class * level, or both. {@code @IfProfileValue} at the class level overrides
* level overrides method-level usage of {@code &#064;IfProfileValue} for * method-level usage of {@code @IfProfileValue} for any methods within that
* any methods within that class. * class.
* </p>
* <p>
* Examples: when using {@link SystemProfileValueSource} as the
* {@link ProfileValueSource} implementation, you can configure a test method to
* run only on Java VMs from Sun Microsystems as follows:
* </p> * </p>
* *
* <h3>Examples</h3>
* <p>
* When using {@link SystemProfileValueSource} as the {@link ProfileValueSource}
* implementation, you can configure a test method to run only on Java VMs from
* Sun Microsystems as follows:
* </p>
* <pre class="code"> * <pre class="code">
* &#064;IfProfileValue(name = &quot;java.vendor&quot;, value = &quot;Sun Microsystems Inc.&quot;) * &#064;IfProfileValue(name = &quot;java.vendor&quot;, value = &quot;Sun Microsystems Inc.&quot;)
* public void testSomething() { * public void testSomething() {
@@ -49,10 +50,10 @@ import java.lang.annotation.Target;
* } * }
* </pre> * </pre>
* <p> * <p>
* You can alternatively configure {@code &#064;IfProfileValue} with * You can alternatively configure {@code @IfProfileValue} with <em>OR</em>
* <em>OR</em> semantics for multiple {@link #values() values} as follows * semantics for multiple {@link #values() values} as follows (assuming a
* (assuming a {@link ProfileValueSource} has been appropriately configured for * {@link ProfileValueSource} has been appropriately configured for the
* the &quot;test-groups&quot; name): * &quot;test-groups&quot; name):
* </p> * </p>
* *
* <pre class="code"> * <pre class="code">