react4j.annotations.PostUpdate Maven / Gradle / Ivy
The newest version!
package react4j.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
/**
* Identifies a method that is called after a view is updated or re-rendered.
* Re-render in this circumstance means that a view has been mounted on the DOM
* and changes to the view are being applied to the dom.
* There must only be one method annotated with this annotation in a view.
* This method is invoked in the "commit" phase using reacts componentDidUpdate()
* lifecycle method.
*
* The method must also conform to the following constraints:
*
* - Must not be annotated with any other react4j annotation
* - Must have 0 parameters
* - Must not return a value
* - Must not be private
* - Must not be public
* - Must not be static
* - Must not be abstract
* - 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 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 PostUpdate
{
}