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 @Prop 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
java.lang.String	name Return the name of the prop.
Feature	require Return enum indicating whether prop should be when component is constructed.

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 theere 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