@@ -18,6 +18,10 @@ public @interface Any { Class<? extends Annotation> after() default NoChange.class; /** + * <b>Please note:</b> support for the except parameter is still not complete. It may yield inappropriate results + * when the object to which this annotation applies is used is in an undefined state, as may be the case for + * example after an {@code if-else} or {@code try-catch-finally} block. + * * @return States that this annotation does not cover. If the object will be in a state that is listed here, * the transition specified by this annotation won't take effect, nor will this annotation accept the object. */ src/checkers/typestate/Any.java @@ -5,6 +5,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** + * A special state annotation used as the default value for elements of the @{@link State} annotation. * @author Adam Warski (adam at warski dot org) */ @Retention(RetentionPolicy.RUNTIME) src/checkers/typestate/NoChange.java @@ -20,6 +20,11 @@ import static java.lang.annotation.ElementType.*; * State annotations (that is, annotations annotated with {@code @State}) can be used on method return, * method parameters, method receivers and constructor receivers. * + * An example of a state annotation: + * <pre> + * @State @interface State1 { Class<?> after() default NoChange.class; Class<?> onException() default NoChange.class; } + * </pre> + * * @author Adam Warski (adam at warski dot org) */ @Retention(RetentionPolicy.RUNTIME) src/checkers/typestate/State.java 8b6eef49eaa2fa14642a4d09668d0bab02627957 Adam Warski adam@warski.org http://github.com/adamw/jsr308-typestate-checker/commit/2193f552fa5ac47366df554d0dc0cb6601d986d9 2193f552fa5ac47366df554d0dc0cb6601d986d9 2009-04-06T10:04:30-07:00 2009-04-06T10:04:30-07:00 Comments update 13a771894b8ca484978b60ea3ef4dfa804914bae Adam Warski adam@warski.org