react4j.annotations.ScheduleRender Maven / Gradle / Ivy
The newest version!
package react4j.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
/**
* Identify a method that can be invoked to schedule the view for re-rendering.
* This annotation is rarely required as the underlying arez reactivity infrastructure
* should be used in preference to this method. The method primarily exists for backwards
* compatibility with earlier versions of the framework.
*
* The method must also conform to the following constraints:
*
* - Must not be annotated with any other react4j annotation
* - Must be abstract
* - Must have 0 parameters
* - Must not return a value
* - Must not be static
* - Must not throw exceptions
* - Must be accessible from the same package as the class annotated by {@link View}
* -
* Should not be public as not expected to be invoked outside the view. A warning will be generated but can
* be suppressed by the {@link SuppressWarnings} or {@link SuppressReact4jWarnings} annotations with a key
* "React4j:PublicMethod". This warning is also suppressed by the annotation processor if it is implementing
* an interface method.
*
* -
* Should not be protected if enclosed in the class annotated with the {@link View} annotation as the
* method is not expected to be invoked outside the view. A warning will be generated but can be suppressed
* by the {@link SuppressWarnings} or {@link SuppressReact4jWarnings} annotations with a
* key "React4j:ProtectedMethod".
*
*
*/
@Documented
@Target( ElementType.METHOD )
public @interface ScheduleRender
{
/**
* Determines whether the view will invoke the shouldComponentUpdate() before invoking the render method.
*
* @return true to skip "shouldViewUpdate" phase, false otherwise.
*/
boolean skipShouldViewUpdate() default true;
}