react4j.annotations

Annotation Type OnPropChange

@Documented
 @Target(value=METHOD)
public @interface OnPropChange

Identifies a method that is called when the value of one of the specified props is changed. Each parameter of the method is mapped to a prop that is tracked. The method will be called before or after the update has occurred and will be passed the previous values of the props as parameters.

Each parameter is expected to be named according to the pattern "last[MyProp]", "prev[MyProp]" or "[myProp]". If name of the parameter does not follow the pattern then the name can be explicitly mapped via the PropRef annotation on a parameter.

The method must also conform to the following constraints:

• Must not be annotated with any other react4j annotation
• Must have 1 or more parameters. Each parameter must map to a prop as described above.
• 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 ReactComponent
• Should not be public as not expected to be invoked outside the component. A warning will be generated but can be suppressed by the SuppressWarnings or 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 ReactComponent annotation as the method is not expected to be invoked outside the component. A warning will be generated but can be suppressed by the SuppressWarnings or SuppressReact4jWarnings annotations with a key "React4j:ProtectedMethod".

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
OnPropChange.Phase	phase The phase in which the method should be invoked.

Element Detail

phase

public abstract OnPropChange.Phase phase

The phase in which the method should be invoked.

Returns:

the phase in which the method should be invoked.

Default:

react4j.annotations.OnPropChange.Phase.PRE