org.eclipse.persistence.internal.oxm.NamespacePrefixMapper Maven / Gradle / Ivy
Show all versions of org.eclipse.persistence.core Show documentation
/*
* Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Blaise Doughan - 2.5 - initial implementation
package org.eclipse.persistence.internal.oxm;
/**
* Purpose:Provides a means to customise the namespace prefixes used while marshalling
* An implementation of this class can be set on an instance of XMLMarshaller to allow for
* each instance of XMLMarshaller to use different namespace prefixes.
*/
public abstract class NamespacePrefixMapper {
/**
* Returns a string array of prefixes and namespace uris that are already available in
* this context. Only required when marshalling to an output stream or a writer, since
* it's not possible to determine which namespaces are already in scope.
* @return
*/
public String[] getContextualNamespaceDecls() {
return new String[0];
}
/**
* Returns a list of namespace uris that should be declared at the root of the xml
* document being marshalled.
*/
public String[] getPreDeclaredNamespaceUris() {
return new String[0];
}
/**
* Returns a string array of prefixes and namespace uris to be declared at the root of
* the document. This eliminates the need of implementing both getPredeclaredNamespaceUris
* and getPreferredPrefix since the prefix and uri can be associated here.
* @return
*/
public String[] getPreDeclaredNamespaceUris2() {
return new String[0];
}
public abstract String getPreferredPrefix(String namespaceUri, String suggestion, boolean requirePrefix);
}