javax.portlet.annotations

Annotation Type PortletPreferencesValidator

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface PortletPreferencesValidator

Designates a preferences validator class. The PortletPreferencesValidator allows validation of the set of portlet preferences before they are stored in the persistent store. The validator method is invoked during execution of the store method of the PortletPreferences.

The annotated class must implement the PreferencesValidator interface.

Since:

3.0

See Also:

PreferencesValidator

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	portletNames The portlet names for which the validator applies.

Element Detail

portletNames

public abstract String[] portletNames

The portlet names for which the validator applies.

The annotated validator method can apply to multiple portlets within the portlet application. The names of the portlets to which the validator applies must be specified in this field.

A wildcard character '*' can be specified in the first portletName array element to indicate that the validator is to apply to all portlets in the portlet application. If specified, the wildcard character must appear alone in the first array element.

Returns:

The portlet names

Default:

"*"