## Package net.sf.saxon.regex

This package contains the code to map XML Schema and XPath regular expressions to the regular expression engine of the underlying Java platform.

See:
Description

Interface Summary
RegexIterator: This class is an interator that supports the evaluation of xsl:analyze-string.
RegularExpression: This interface represents a compiled regular expression

Class Summary
CaseVariants: This class holds data about the case-variants of Unicode characters.
RegexData: Non-instantiable class containing constant data definitions used by the various Regular Expression translators
RegexTranslator: Abstract superclass for the various regex translators, which differ according to the target platform.
RegexTranslator.Range: A Range represents a range of consecutive Unicode codepoints
SurrogateRegexTranslator: Abstract superclass for the JDK 1.4 and .NET regex translators, or in principle for any other target regex dialect in which "." matches a UTF-16 16-bit code rather than a Unicode character
SurrogateRegexTranslator.BackReference: Character class representing a back-reference.
SurrogateRegexTranslator.CharClass: Object representing a character class
SurrogateRegexTranslator.CharRange: Character class that matches any character within a range of codepoints
SurrogateRegexTranslator.Complement: Character class representing the complement of another character class, that is, all characters that the other class doesn't match.
SurrogateRegexTranslator.Dot: Character class representing the characters matched by the XPath "." metacharacter
SurrogateRegexTranslator.Empty: Character class that matches nothing
SurrogateRegexTranslator.Property: Character class containing characters that share a given Unicode property
SurrogateRegexTranslator.SimpleCharClass: Simple Character Class - essentially, anything other than a Union or Subtraction between two character classes.
SurrogateRegexTranslator.SingleChar: Character class that matches a single specific character in the BMP
SurrogateRegexTranslator.WideSingleChar: Character class that matches a single specific character outside the BMP

Exception Summary
RegexSyntaxException: Thrown when an syntactically incorrect regular expression is detected.

## Package net.sf.saxon.regex Description

This package contains the code to map XML Schema and XPath regular expressions to the regular expression engine of the underlying Java platform.

Regular expressions are translated into the form accepted by JDK 1.5 or JDK 1.4. There are two separate versions of the translator because these two platforms differ radically in how Unicode characters outside the basic multilingual plane are handled.

Users should not normally need to use these classes directly.

Most of the code used in these translators was developed originally by James Clark.

Copyright (c) Saxonica Limited. All rights reserved.