org.docx4j.jaxb.suninternal

Class NamespacePrefixMapperRelationshipsPart

java.lang.Object

com.sun.xml.internal.bind.marshaller.NamespacePrefixMapper

org.docx4j.jaxb.suninternal.NamespacePrefixMapperRelationshipsPart

All Implemented Interfaces:

McIgnorableNamespaceDeclarator, NamespacePrefixMapperInterface

public class NamespacePrefixMapperRelationshipsPart
extends com.sun.xml.internal.bind.marshaller.NamespacePrefixMapper
implements NamespacePrefixMapperInterface, McIgnorableNamespaceDeclarator

Constructor Summary

Constructors

Constructor and Description
NamespacePrefixMapperRelationshipsPart()

Method Summary

Modifier and Type	Method and Description
String	getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix) Returns a preferred prefix for the given namespace URI; this one is used *only* when we marshal the relationships part.
void	setMcIgnorable(String mcIgnorable)

Methods inherited from class com.sun.xml.internal.bind.marshaller.NamespacePrefixMapper

getContextualNamespaceDecls, getPreDeclaredNamespaceUris, getPreDeclaredNamespaceUris2

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.docx4j.jaxb.NamespacePrefixMapperInterface

getContextualNamespaceDecls, getPreDeclaredNamespaceUris, getPreDeclaredNamespaceUris2

Constructor Detail

NamespacePrefixMapperRelationshipsPart

public NamespacePrefixMapperRelationshipsPart()

Method Detail

setMcIgnorable

public void setMcIgnorable(String mcIgnorable)

Specified by:

setMcIgnorable in interface McIgnorableNamespaceDeclarator

getPreferredPrefix

public String getPreferredPrefix(String namespaceUri,
                                 String suggestion,
                                 boolean requirePrefix)

Returns a preferred prefix for the given namespace URI; this one is used *only* when we marshal the relationships part. This method is intended to be overrided by a derived class.

Specified by:

getPreferredPrefix in interface NamespacePrefixMapperInterface

Specified by:

getPreferredPrefix in class com.sun.xml.internal.bind.marshaller.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. Typically this value comes from 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 preferred 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.