The NamespacePrefixMapper.java Java example source code
/*
* Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.xml.internal.bind.marshaller;
import java.io.OutputStream;
import javax.xml.bind.JAXBContext;
import javax.xml.stream.XMLEventWriter;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.dom.DOMResult;
import org.w3c.dom.Node;
// be careful about changing this class. this class is supposed to be
// extended by users and therefore we are not allowed to break
// those user code.
//
// this means:
// - don't add any abstract method
// - don't change any existing method signature
// - don't remove any existing method.
/**
* Implemented by the user application to determine URI -> prefix
* mapping.
*
* This is considered as an interface, though it's implemented
* as an abstract class to make it easy to add new methods in
* a future.
*
* @author
* Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
*/
public abstract class NamespacePrefixMapper {
private static final String[] EMPTY_STRING = new String[0];
/**
* Returns a preferred prefix for the given namespace URI.
*
* This method is intended to be overrided by a derived class.
*
* <p>
* 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:
*
* <ol>
* <li>
* 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 {@link String}), partly to simplify the marshaller.
* <li>
* If the prefix returned is "" yet the current {@link 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.
* </ol>
*
* @param namespaceUri
* The namespace URI for which the prefix needs to be found.
* Never be null. "" is used to denote the default namespace.
* @param 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.
* @param 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.
*
* @return
* 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.
*
* @since JAXB 1.0.1
*/
public abstract String getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix);
/**
* Returns a list of namespace URIs that should be declared
* at the root element.
*
* <p>
* By default, the JAXB RI 1.0.x produces namespace declarations only when
* they are necessary, only at where they are used. Because of this
* lack of look-ahead, sometimes the marshaller produces a lot of
* namespace declarations that look redundant to human eyes. For example,
* <pre><![CDATA[
* <?xml version="1.0"?>
* <root>
* <ns1:child xmlns:ns1="urn:foo"> ... </ns1:child>
* <ns2:child xmlns:ns2="urn:foo"> ... </ns2:child>
* <ns3:child xmlns:ns3="urn:foo"> ... </ns3:child>
* ...
* </root>
* </xmp></pre>
*
* <p>
* The JAXB RI 2.x mostly doesn't exhibit this behavior any more,
* as it declares all statically known namespace URIs (those URIs
* that are used as element/attribute names in JAXB annotations),
* but it may still declare additional namespaces in the middle of
* a document, for example when (i) a QName as an attribute/element value
* requires a new namespace URI, or (ii) DOM nodes as a portion of an object
* tree requires a new namespace URI.
*
* <p>
* If you know in advance that you are going to use a certain set of
* namespace URIs, you can override this method and have the marshaller
* declare those namespace URIs at the root element.
*
* <p>
* For example, by returning <code>new String[]{"urn:foo"}</code>,
* the marshaller will produce:
* <pre><xmp>
* <?xml version="1.0"?>
* <root xmlns:ns1="urn:foo">
* <ns1:child> ... </ns1:child>
* <ns1:child> ... </ns1:child>
* <ns1:child> ... </ns1:child>
* ...
* </root>
* </xmp></pre>
* <p>
* To control prefixes assigned to those namespace URIs, use the
* {@link #getPreferredPrefix(String, String, boolean)} method.
*
* @return
* A list of namespace URIs as an array of {@link String}s.
* This method can return a length-zero array but not null.
* None of the array component can be null. To represent
* the empty namespace, use the empty string <code>""</code>.
*
* @since
* JAXB RI 1.0.2
*/
public String[] getPreDeclaredNamespaceUris() {
return EMPTY_STRING;
}
/**
* Similar to {@link #getPreDeclaredNamespaceUris()} but allows the
* (prefix,nsUri) pairs to be returned.
*
* <p>
* With {@link #getPreDeclaredNamespaceUris()}, applications who wish to control
* the prefixes as well as the namespaces needed to implement both
* {@link #getPreDeclaredNamespaceUris()} and {@link #getPreferredPrefix(String, String, boolean)}.
*
* <p>
* This version eliminates the needs by returning an array of pairs.
*
* @return
* always return a non-null (but possibly empty) array. The array stores
* data like (prefix1,nsUri1,prefix2,nsUri2,...) Use an empty string to represent
* the empty namespace URI and the default prefix. Null is not allowed as a value
* in the array.
*
* @since
* JAXB RI 2.0 beta
*/
public String[] getPreDeclaredNamespaceUris2() {
return EMPTY_STRING;
}
/**
* Returns a list of (prefix,namespace URI) pairs that represents
* namespace bindings available on ancestor elements (that need not be repeated
* by the JAXB RI.)
*
* <p>
* Sometimes JAXB is used to marshal an XML document, which will be
* used as a subtree of a bigger document. When this happens, it's nice
* for a JAXB marshaller to be able to use in-scope namespace bindings
* of the larger document and avoid declaring redundant namespace URIs.
*
* <p>
* This is automatically done when you are marshalling to {@link XMLStreamWriter},
* {@link XMLEventWriter}, {@link DOMResult}, or {@link Node}, because
* those output format allows us to inspect what's currently available
* as in-scope namespace binding. However, with other output format,
* such as {@link OutputStream}, the JAXB RI cannot do this automatically.
* That's when this method comes into play.
*
* <p>
* Namespace bindings returned by this method will be used by the JAXB RI,
* but will not be re-declared. They are assumed to be available when you insert
* this subtree into a bigger document.
*
* <p>
* It is <b>NOT</b> OK to return the same binding, or give
* the receiver a conflicting binding information.
* It's a responsibility of the caller to make sure that this doesn't happen
* even if the ancestor elements look like:
* <pre><xmp>
* <foo:abc xmlns:foo="abc">
* <foo:abc xmlns:foo="def">
* <foo:abc xmlns:foo="abc">
* ... JAXB marshalling into here.
* </foo:abc>
* </foo:abc>
* </foo:abc>
* </xmp></pre>
*
* @return
* always return a non-null (but possibly empty) array. The array stores
* data like (prefix1,nsUri1,prefix2,nsUri2,...) Use an empty string to represent
* the empty namespace URI and the default prefix. Null is not allowed as a value
* in the array.
*
* @since JAXB RI 2.0 beta
*/
public String[] getContextualNamespaceDecls() {
return EMPTY_STRING;
}
}
</pre>
<div id="after_source_code">
<h2>Other Java examples (source code examples)</h2>
<p>Here is a short list of links related to this Java NamespacePrefixMapper.java source code file:</p>
<ul>
<li><a href="/java/jwarehouse"><img src="/images/scw/find.png" border="0"> The search page</a></li>
<li><a href="index.shtml"><img src="/images/scw/folder.png" border="0"> Other Java source code examples at this package level</a></li>
<li><a href="/java/jwarehouse/about.shtml"><img src="/images/scw/information.png" border="0"> Click here to learn more about this project</a></li>
</ul>
</div>
</td>
</tr>
</table>
</div>
</div>
<div style="padding-top: 1em; width: 310px; margin-left: auto; margin-right: auto; table {border-collapse: collapse; border: none;}; tr {border-collapse: collapse; border: none; text-align: center;};">
<table width="100%" cellspacing="0" cellpadding="0">
<tr>
<td colspan="2" style="border-collapse: collapse; border: none; text-align: center;};">
<em>... this post is sponsored by my books ...</em>
</td>
</tr>
<tr>
<td width="150" style="border-collapse: collapse; border: none; text-align: center;};">
<a href="https://kbhr.co/ckbk-v2"><img
src="/images/books/scala-cookbook-v2-cover-220h.jpg"
title="The Scala Cookbook, by Alvin Alexander" height="220" />
<br /><span style="opacity: 0.4;">#1 New Release!</span></a>
</td>
<td width="150" style="border-collapse: collapse; border: none; text-align: center; padding-left: 8px;">
<a href="http://kbhr.co/fps-book"><img
src="/images/books/functional-programming-simplified-small.jpg"
title="Functional Programming, Simplified, by Alvin Alexander"
height="220" />
<br /><span style="opacity: 0.4;">FP Best Seller</span></a>
</td>
</tr>
</table>
<p> </p>
</div>
<div id="whats_new">
<h2>new blog posts</h2>
<div id="whats_new_list">
<ul>
<li><a class="whats_new_link" href="/scala/scala-cli-compiling-running-scala-3-code-watching">Scala CLI (Compiling and Running Code)</a></li>
<li><a class="whats_new_link" href="/personal/ezoic-ads-vs-google-adsense-2024">Ezoic ads vs Google AdSense (2024, website advertising revenue/partner)</a></li>
<li><a class="whats_new_link" href="/misc/when-in-present-moment-some-questions-dont-make-sense">If you'''re truly living in the present moment, some questions don'''t make sense</a></li>
<br/>
<li><a class="whats_new_link" href="/misc/how-give-up-attachments-addiction-bhagavad-gita-true-self">Mindfulness/Meditation: How to give up attachment and addiction (from the Bhagavad Gita)</a></li>
<li><a class="whats_new_link" href="/misc/dream-vacation-for-meditator-meditation">A dream vacation for the meditator in your life</a></li>
<li><a class="whats_new_link" href="/scala/zio-zlayer-very-simple-example-dependency-injection-services">ZIO ZLayer: A simple '''Hello, world''' example (dependency injection, services)</a></li>
<br/>
<li><a class="whats_new_link" href="/misc/trying-find-way-love-everyone-in-world-dont-like-dark-night-soul">Trying to find a way to love everyone in a world ...</a></li>
<li><a class="whats_new_link" href="/scala/ammonite-repl-how-import-managed-dependencies-jar-files-syntax">Ammonite REPL: How to import managed dependencies (and JAR files, too)</a></li>
<li><a class="whats_new_link" href="/source-code/scala-how-use-zio-2-in-ammonite-repl">How to use ZIO 2 in the Ammonite REPL</a></li>
<br/>
<br/>
</div>
</ul>
</div>
<p> </p>
<p align="center"><font color="#000000" size="2"
face="Verdana,Arial">Copyright 1998-2021 Alvin Alexander, alvinalexander.com<br/>
All Rights Reserved.<br/>
<br/>
A percentage of advertising revenue from<br/>
pages under the <a href="/java/jwarehouse">/java/jwarehouse</a>
URI on this website is<br/>
paid back to open source projects.</p>
<script>
shuffle(books);
var div = document.getElementById("leftcol");
var pre = '<div style="margin: 0; padding-right: 1.6em"><h2 align="center">favorite books</h2>';
var post = '</div>';
if (adblock) {
var str = books.slice(0,3).join(" ");
div.insertAdjacentHTML('beforeend', pre + str + post);
} else {
var str = books.slice(0,1).join(" ");
div.insertAdjacentHTML('beforeend', pre + str + post);
}
</script>
<p style="padding-bottom: 80px;"> </p>
</body>
]]> 