public class XmlNamespacePrefixMapper extends NamespacePrefixMapper
Constructor and Description |
---|
XmlNamespacePrefixMapper(XmlNs... namespaces)
Create a new XmlNamespecePrefixMapper.
|
Modifier and Type | Method and Description |
---|---|
String |
getPreferredPrefix(String namespaceUri,
String suggestion,
boolean requirePrefix)
Returns a preferred prefix for the given namespace URI.
|
getContextualNamespaceDecls, getPreDeclaredNamespaceUris, getPreDeclaredNamespaceUris2
public XmlNamespacePrefixMapper(XmlNs... namespaces)
namespaces
- xml namespacespublic String getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix)
NamespacePrefixMapper
As noted in the return value portion of the javadoc, there are several cases where the preference cannot be honored. Specifically, as of JAXB RI 2.0 and onward:
String
), partly to simplify the marshaller.
JAXBContext
includes classes that use the empty namespace URI. This allows
the JAXB RI to reserve the "" prefix for the empty namespace URI,
which is the only possible prefix for the URI.
This restriction is also to simplify the marshaller.
getPreferredPrefix
in class NamespacePrefixMapper
namespaceUri
- The namespace URI for which the prefix needs to be found.
Never be null. "" is used to denote the default namespace.suggestion
- When the content tree has a suggestion for the prefix
to the given namespaceUri, that suggestion is passed as a
parameter. Typicall this value comes from the QName.getPrefix
to show the preference of the content tree. This parameter
may be null, and this parameter may represent an already
occupied prefix.requirePrefix
- If this method is expected to return non-empty prefix.
When this flag is true, it means that the given namespace URI
cannot be set as the default namespace.Copyright © 2020 JBoss by Red Hat. All rights reserved.