com.sun.xml.ws.security.trust.util
Class TrustNamespacePrefixMapper
java.lang.Object
com.sun.xml.bind.marshaller.NamespacePrefixMapper
com.sun.xml.ws.security.trust.util.TrustNamespacePrefixMapper
public class TrustNamespacePrefixMapper
- extends NamespacePrefixMapper
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TrustNamespacePrefixMapper
public TrustNamespacePrefixMapper()
getPreferredPrefix
public String getPreferredPrefix(String namespaceUri,
String suggestion,
boolean requirePrefix)
- Description copied from class:
NamespacePrefixMapper
- Returns a preferred prefix for the given namespace URI.
This method is intended to be overrided by a derived class.
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:
-
If the prefix returned is already in use as one of the in-scope
namespace bindings. This is partly necessary for correctness
(so that we don't unexpectedly change the meaning of QNames
bound to
String), partly to simplify the marshaller.
-
If the prefix returned is "" yet the current
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.
- Specified by:
getPreferredPrefix in class NamespacePrefixMapper
- Parameters:
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.
- Returns:
- null if there's no prefered prefix for the namespace URI.
In this case, the system will generate a prefix for you.
Otherwise the system will try to use the returned prefix,
but generally there's no guarantee if the prefix will be
actually used or not.
return "" to map this namespace URI to the default namespace.
Again, there's no guarantee that this preference will be
honored.
If this method returns "" when requirePrefix=true, the return
value will be ignored and the system will generate one.
Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.