net.sf.saxon.lib.URIChecker Maven / Gradle / Ivy
Show all versions of saxon-he Show documentation
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2013 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.lib;
/**
* This interface defines a method for checking whether a string is considered to be a valid URI.
*
* A user-supplied implementation of this class can be set in a customized instance of
* {@link ConversionRules}, which can be set in the configuration using
* {@link net.sf.saxon.Configuration#setConversionRules(ConversionRules)}
*
* A user-supplied implementation can be written either from scratch, or by reference to the
* system-supplied implementation {@link StandardURIChecker}.
*/
public interface URIChecker {
/**
* Check whether a given string is considered valid according to the rules of the xs:anyURI type.
*
This method is called during schema validation, and when casting string to xs:anyURI. It is not
* used when the xs:anyURI type is used as a return value from methods such as namespace-uri() or
* namespace-uri-from-QName() - in such cases no checking is applied to the name.
* @param value the string to be checked
* @return true if the string is considered to represent a valid URI
*/
boolean isValidURI(CharSequence value);
}