com.sun.xml.xsom.XmlString Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.xsom;
import org.relaxng.datatype.ValidationContext;
/**
* String with in-scope namespace binding information.
*
*
* In a general case, text (PCDATA/attributes) that appear in XML schema
* cannot be correctly interpreted unless you also have in-scope namespace
* binding (a case in point is QName.) Therefore, it's convenient to
* handle the lexical representation and the in-scope namespace binding
* in a pair.
*
* @author Kohsuke Kawaguchi
*/
public final class XmlString {
/**
* Textual value. AKA lexical representation.
*/
public final String value;
/**
* Used to resole in-scope namespace bindings.
*/
public final ValidationContext context;
/**
* Creates a new {@link XmlString} from a lexical representation and in-scope namespaces.
*/
public XmlString(String value, ValidationContext context) {
this.value = value;
this.context = context;
if(context==null)
throw new IllegalArgumentException();
}
/**
* Creates a new {@link XmlString} with empty in-scope namespace bindings.
*/
public XmlString(String value) {
this(value,NULL_CONTEXT);
}
/**
* Resolves a namespace prefix to the corresponding namespace URI.
*
* This method is used for resolving prefixes in the {@link #value}
* (such as when {@link #value} represents a QName type.)
*
*
* If the prefix is "" (empty string), the method
* returns the default namespace URI.
*
*
* If the prefix is "xml", then the method returns
* "http://www.w3.org/XML/1998/namespace",
* as defined in the XML Namespaces Recommendation.
*
* @return
* namespace URI of this prefix.
* If the specified prefix is not declared,
* the implementation returns null.
*/
public final String resolvePrefix(String prefix) {
return context.resolveNamespacePrefix(prefix);
}
public String toString() {
return value;
}
private static final ValidationContext NULL_CONTEXT = new ValidationContext() {
public String resolveNamespacePrefix(String s) {
if(s.length()==0) return "";
if(s.equals("xml")) return "http://www.w3.org/XML/1998/namespace";
return null;
}
public String getBaseUri() {
return null;
}
public boolean isUnparsedEntity(String s) {
return false;
}
public boolean isNotation(String s) {
return false;
}
};
}