Mercurial > hg > Members > tatsuki > functionaljava-master > core
comparison src/main/java/fj/test/reflect/package-info.java @ 0:fe80c1edf1be
add getLoop
| author | tatsuki |
|---|---|
| date | Fri, 20 Mar 2015 21:04:03 +0900 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:fe80c1edf1be |
|---|---|
| 1 /** | |
| 2 * A wrapper around the <code>fj.test</code> package that uses annotations for configuring properties to | |
| 3 * check. The properties are found using reflection. All annotations | |
| 4 * are optional and a property is eligible for checking by default. A property is any of the | |
| 5 * following member descriptions, unless the member or enclosing class is annotated with | |
| 6 * {@link fj.test.reflect.NoCheck}. | |
| 7 * | |
| 8 <ul> | |
| 9 <li>a static field of type {@link fj.test.Property}.</li> | |
| 10 <li>a static zero argument method that returns {@link fj.test.Property}.</li> | |
| 11 <li>a non-static field of type {@link fj.test.Property} in a class with a zero-argument constructor.</li> | |
| 12 <li>a non-static no-argument method that returns {@link fj.test.Property} in a class with a no-argument | |
| 13 constructor.</li> | |
| 14 </ul> | |
| 15 * | |
| 16 * <p> | |
| 17 * A property may be in zero or more categories by annotating the member or enclosing class with | |
| 18 * {@link fj.test.reflect.Category}. The property is in the set of categories that make up the | |
| 19 * union of its member and enclosing class category annotation. | |
| 20 * </p> | |
| 21 * <p> | |
| 22 * When a property is checked, it uses default configuration values, which may be overridden by | |
| 23 * annotating the member or the enclosing class with the {@link fj.test.reflect.CheckParams} | |
| 24 * annotation. The values used are first those specified on the member; or if the annotation does | |
| 25 * not exist, then the enclosing class (default values otherwise). | |
| 26 * </p> | |
| 27 * <p> | |
| 28 * A property can have a name associated with it by annotating the member with the | |
| 29 * {@link fj.test.reflect.Name} annotation. The name is a {@link java.lang.String} that is used | |
| 30 * only for reporting in check results. If the {@link fj.test.reflect.Name} annotation does not | |
| 31 * appear on a property member, then the field or method name is used by default. | |
| 32 * </p> | |
| 33 * | |
| 34 * @version %build.number% | |
| 35 */ | |
| 36 package fj.test.reflect; |