javax.portlet.annotations

Annotation Type PortletQName

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

This annotation is used within composite portlet configuration annotations to represent a QName for use in portlet event and public render parameter definitions. It cannot be used as a stand-alone portlet annotation.

The qname is specified as a string of the form namespace-name:local-part, where

• namespace-name is a URI specifying the namespace.
• local-part is a non-empty String.

Since:

3.0

See Also:

javax.xml.namespace.QName, W3C Qname definition

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	localPart The local part.
String	namespaceURI The QName namespace URI.

Element Detail

namespaceURI

public abstract String namespaceURI

The QName namespace URI.

If the QName namespace URI is empty, the default value is used. The default value is taken from the following locations, specified in order of precedence:

• The value defined in the <default-namespace> element in the portlet deployment descriptor.
• The value defined in the <defaultNamespace> element in the @PortletApplication annotation.
• The value javax.xml.XMLConstants.NULL_NS_URI

Returns:

The QName namespace URI.

See Also:

PortletApplication.defaultNamespaceURI()

localPart

public abstract String localPart

The local part.

local-part should be a non-empty String.

Returns:

The qname local part.