react4j.annotations

Annotation Type Prop

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

Annotation used to specify an abstract method that returns a prop. The property is extracted from Reacts underlying props object.

The method that is annotated with this annotation must also comply with the following constraints:

• Must not be annotated with any other react annotation
• Must have 0 parameters
• Must return a value
• Must be an abstract instance method
• Must not throw exceptions
• Must be accessible from the same package as the class annotated by ReactComponent

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Feature	disposable Return an enum indicating whether prop is disposable and should be checked before rendering component.
java.lang.String	name Return the name of the prop.
Feature	observable Indicate whether the prop is an Arez observable.
Feature	require Return enum indicating whether prop should be when component is constructed.
Feature	shouldUpdateOnChange Return an enum indicating whether prop should trigger a change if it updated.

Element Detail

name

@Nonnull
public abstract java.lang.String name

Return the name of the prop. If the underlying method conforms to java beans accessor conventions (i.e. starts with "is" and is a boolean or starts with "get") then the name is the same as the java bean convention dictates, otherwise the name of the method is used as the default value for the prop.

Returns:

the name of the prop.

Default:

"<default>"

require

public abstract Feature require

Return enum indicating whether prop should be when component is constructed. This influences validation when enabled and how the Builder class is created. If set to Feature.ENABLE then the user MUST supply the prop and the builder will require the user to specify the value. If set to Feature.DISABLE then the user can optionally supply the prop. If set to Feature.AUTODETECT then the annotation processor will treat it as Feature.DISABLE if there is a corresponding PropDefault for the prop, otherwise it will be treated as Feature.ENABLE.

Returns:

the flag indicating whether the prop needs to be supplied.

Default:

react4j.annotations.Feature.AUTODETECT

shouldUpdateOnChange

public abstract Feature shouldUpdateOnChange

Return an enum indicating whether prop should trigger a change if it updated. If set to Feature.ENABLE then the code will check the prop when implementing shouldComponentUpdate while setting the value to Feature.DISABLE will result in the value of the prop being ignored when determining whether a prop change should cause a re-render. If set to Feature.AUTODETECT then the annotation processor will treat it as Feature.ENABLE.

Returns:

the enum indicating whether prop should trigger a render if it is modified.

Default:

react4j.annotations.Feature.AUTODETECT

observable

public abstract Feature observable

Indicate whether the prop is an Arez observable. If set to Feature.ENABLE the generated class will make the prop observable and report changes in the prop when the prop changes. The component MUST be a subclass of ReactArezComponent. If set to Feature.DISABLE then the prop will not be observable. If set to Feature.AUTODETECT then the prop will be observable if the component is a subclass of ReactArezComponent, the value of shouldUpdateOnChange() is not Feature.DISABLE and the component has a method annotated with arez.annotations.Computed, arez.annotations.Memoize or arez.annotations.Observe.

Returns:

the enum indicating whether prop is observable.

Default:

react4j.annotations.Feature.AUTODETECT

disposable

public abstract Feature disposable

Return an enum indicating whether prop is disposable and should be checked before rendering component. If a prop is disposable then the class will override ReactArezComponent.anyPropsDisposed() and check whether the prop is disposed prior to attempting to render the component. If any props are disposed then rendering will be aborted and the render method will return null. If set to Feature.ENABLE then the code will add an isDisposed() check while if set to Feature.DISABLE no such check will be generated. If set to Feature.AUTODETECT then the annotation processor will inspect the type of the prop and treat it as Feature.ENABLE if the type is annotated with the arez.annotations.ArezComponent annotation and the host component is an Arez component. It is invalid to specify Feature.ENABLE unless the host component is an Arez component.

Returns:

the enum indicating whether prop is disposable and should be checked before rendering component.

Default:

react4j.annotations.Feature.AUTODETECT