Package net.sf.saxon.regex
Class JavaRegularExpression
- java.lang.Object
-
- net.sf.saxon.regex.JavaRegularExpression
-
- All Implemented Interfaces:
RegularExpression
public class JavaRegularExpression extends java.lang.Object implements RegularExpression
An implementation of RegularExpression that calls the JDK regular expression library directly. This can be invoked by appending ";j" to the flags attribute/argument
-
-
Constructor Summary
Constructors Constructor Description JavaRegularExpression(java.lang.CharSequence javaRegex, java.lang.String flags)Create a regular expression, starting with an already-translated Java regex.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RegexIteratoranalyze(java.lang.CharSequence input)Use this regular expression to analyze an input string, in support of the XSLT analyze-string instruction.booleancontainsMatch(java.lang.CharSequence input)Determine whether the regular expression contains a match for a given stringintgetFlagBits()Get the flag bits as used by the Java regular expression enginejava.lang.StringgetFlags()Get the flags used at the time the regular expression was compiled.java.lang.StringgetJavaRegularExpression()Get the Java regular expression (after translation from an XPath regex, but before compilation)booleanmatches(java.lang.CharSequence input)Determine whether the regular expression matches a given string in its entiretyjava.lang.CharSequencereplace(java.lang.CharSequence input, java.lang.CharSequence replacement)Replace all substrings of a supplied input string that match the regular expression with a replacement string.java.lang.CharSequencereplaceWith(java.lang.CharSequence input, java.util.function.Function<java.lang.CharSequence,java.lang.CharSequence> replacement)Replace all substrings of a supplied input string that match the regular expression with a replacement string.static intsetFlags(java.lang.CharSequence inFlags)Set the Java flags from the supplied XPath flags.AtomicIterator<StringValue>tokenize(java.lang.CharSequence input)Use this regular expression to tokenize an input string.
-
-
-
Constructor Detail
-
JavaRegularExpression
public JavaRegularExpression(java.lang.CharSequence javaRegex, java.lang.String flags) throws XPathExceptionCreate a regular expression, starting with an already-translated Java regex. NOTE: this constructor is called from compiled XQuery code- Parameters:
javaRegex- the regular expression after translation to Java notationflags- the user-specified flags (prior to any semicolon)- Throws:
XPathException
-
-
Method Detail
-
getJavaRegularExpression
public java.lang.String getJavaRegularExpression()
Get the Java regular expression (after translation from an XPath regex, but before compilation)- Returns:
- the regular expression in Java notation
-
getFlagBits
public int getFlagBits()
Get the flag bits as used by the Java regular expression engine- Returns:
- the flag bits
-
analyze
public RegexIterator analyze(java.lang.CharSequence input)
Use this regular expression to analyze an input string, in support of the XSLT analyze-string instruction. The resulting RegexIterator provides both the matching and non-matching substrings, and allows them to be distinguished. It also provides access to matched subgroups.- Specified by:
analyzein interfaceRegularExpression- Parameters:
input- the character string to be analyzed using the regular expression- Returns:
- an iterator over matched and unmatched substrings
-
containsMatch
public boolean containsMatch(java.lang.CharSequence input)
Determine whether the regular expression contains a match for a given string- Specified by:
containsMatchin interfaceRegularExpression- Parameters:
input- the string to match- Returns:
- true if the string matches, false otherwise
-
matches
public boolean matches(java.lang.CharSequence input)
Determine whether the regular expression matches a given string in its entirety- Specified by:
matchesin interfaceRegularExpression- Parameters:
input- the string to match- Returns:
- true if the string matches, false otherwise
-
replace
public java.lang.CharSequence replace(java.lang.CharSequence input, java.lang.CharSequence replacement) throws XPathExceptionReplace all substrings of a supplied input string that match the regular expression with a replacement string.- Specified by:
replacein interfaceRegularExpression- Parameters:
input- the input string on which replacements are to be performedreplacement- the replacement string in the format of the XPath replace() function- Returns:
- the result of performing the replacement
- Throws:
XPathException- if the replacement string is invalid
-
replaceWith
public java.lang.CharSequence replaceWith(java.lang.CharSequence input, java.util.function.Function<java.lang.CharSequence,java.lang.CharSequence> replacement) throws XPathExceptionReplace all substrings of a supplied input string that match the regular expression with a replacement string.- Specified by:
replaceWithin interfaceRegularExpression- Parameters:
input- the input string on which replacements are to be performedreplacement- a function that is called once for each matching substring, and that returns a replacement for that substring- Returns:
- the result of performing the replacement
- Throws:
XPathException- if the replacement string is invalid
-
tokenize
public AtomicIterator<StringValue> tokenize(java.lang.CharSequence input)
Use this regular expression to tokenize an input string.- Specified by:
tokenizein interfaceRegularExpression- Parameters:
input- the string to be tokenized- Returns:
- a SequenceIterator containing the resulting tokens, as objects of type StringValue
-
setFlags
public static int setFlags(java.lang.CharSequence inFlags) throws XPathExceptionSet the Java flags from the supplied XPath flags. The flags recognized have their Java-defined meanings rather than their XPath-defined meanings. The available flags are:d - UNIX_LINES
m - MULTILINE
i - CASE_INSENSITIVE
s - DOTALL
x - COMMENTS
u - UNICODE_CASE
q - LITERAL
c - CANON_EQ
- Parameters:
inFlags- the flags as a string, e.g. "im"- Returns:
- the flags as a bit-significant integer
- Throws:
XPathException- if the supplied value contains an unrecognized flag character- See Also:
Pattern
-
getFlags
public java.lang.String getFlags()
Get the flags used at the time the regular expression was compiled.- Specified by:
getFlagsin interfaceRegularExpression- Returns:
- a string containing the flags
-
-