annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
1 /**
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
2 * A wrapper around the <code>fj.test</code> package that uses annotations for configuring properties to
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
3 * check. The properties are found using reflection. All annotations
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
4 * are optional and a property is eligible for checking by default. A property is any of the
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
5 * following member descriptions, unless the member or enclosing class is annotated with
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
6 * {@link fj.test.reflect.NoCheck}.
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
7 *
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
8 <ul>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
9 <li>a static field of type {@link fj.test.Property}.</li>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
10 <li>a static zero argument method that returns {@link fj.test.Property}.</li>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
11 <li>a non-static field of type {@link fj.test.Property} in a class with a zero-argument constructor.</li>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
12 <li>a non-static no-argument method that returns {@link fj.test.Property} in a class with a no-argument
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
13 constructor.</li>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
14 </ul>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
15 *
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
16 * <p>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
17 * A property may be in zero or more categories by annotating the member or enclosing class with
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
18 * {@link fj.test.reflect.Category}. The property is in the set of categories that make up the
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
19 * union of its member and enclosing class category annotation.
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
20 * </p>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
21 * <p>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
22 * When a property is checked, it uses default configuration values, which may be overridden by
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
23 * annotating the member or the enclosing class with the {@link fj.test.reflect.CheckParams}
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
24 * annotation. The values used are first those specified on the member; or if the annotation does
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
25 * not exist, then the enclosing class (default values otherwise).
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
26 * </p>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
27 * <p>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
28 * A property can have a name associated with it by annotating the member with the
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
29 * {@link fj.test.reflect.Name} annotation. The name is a {@link java.lang.String} that is used
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
30 * only for reporting in check results. If the {@link fj.test.reflect.Name} annotation does not
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
31 * appear on a property member, then the field or method name is used by default.
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
32 * </p>
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
33 *
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
34 * @version %build.number%
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
35 */
fe80c1edf1be add getLoop
tatsuki
parents:
diff changeset
36 package fj.test.reflect;