javax.portlet.annotations

Annotation Type InitParameter

@Retention(value=RUNTIME)
 @Target(value=ANNOTATION_TYPE)
public @interface InitParameter

This annotation is used within composite portlet configuration annotations to represent name-value pairs. It cannot be used as a stand-alone portlet annotation.

Since:

3.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The parameter name.
String	value The parameter value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
LocaleString[]	description Provides locale-specific text describing the initialization parameter for use by the portal application or by tools.

Element Detail

name

public abstract String name

The parameter name.

Returns:

The parameter name

value

public abstract String value

The parameter value

Returns:

The parameter value

description

public abstract LocaleString[] description

Provides locale-specific text describing the initialization parameter for use by the portal application or by tools.

Returns:

The parameter description

Default:

{}