Top Description Methods
javax.portlet.annotations

public @Interface PortletQName

extends Annotation
Annotations
@Retention:RUNTIME
@Target:ANNOTATION_TYPE
Imports
java.lang.annotation.Retention, .Target

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

Since
3.0
See Also
javax.xml.namespace.QName, W3C Qname definition

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The qname local part.
localPart
()

The local part.
public String

Returns:

The QName namespace URI.
namespaceURI
()

The QName namespace URI.
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

localPartback to summary
public String localPart()

The local part.

local-part should be a non-empty String.

Returns:String

The qname local part.

namespaceURIback to summary
public 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:String

The QName namespace URI.

See Also
PortletApplication#defaultNamespaceURI()