org.ucl.xpath.function
Class FnMatches

java.lang.Object
  extended byorg.ucl.xpath.function.Function
      extended byorg.ucl.xpath.function.FnMatches

public class FnMatches
extends Function

The function returns true if $input matches the regular expression supplied as $pattern as influenced by the value of $flags, if present; otherwise, it returns false.


Field Summary
 
Fields inherited from class org.ucl.xpath.function.Function
_arity, _fl, _name
 
Constructor Summary
FnMatches()
          Constructor for FnMatches.
 
Method Summary
 ResultSequence evaluate(java.util.Collection args)
          Evaluate arguments.
static java.util.Collection expected_args()
          Obtain a list of expected arguments.
static ResultSequence matches(java.util.Collection args)
          Matches operation.
 
Methods inherited from class org.ucl.xpath.function.Function
arity, convert_argument, convert_arguments, dynamic_context, name, set_function_library, signature, signature, signature, static_context
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FnMatches

public FnMatches()
Constructor for FnMatches.

Method Detail

evaluate

public ResultSequence evaluate(java.util.Collection args)
                        throws DynamicError
Evaluate arguments.

Specified by:
evaluate in class Function
Parameters:
args - argument expressions.
Returns:
Result of evaluation.
Throws:
DynamicError - Dynamic error.

matches

public static ResultSequence matches(java.util.Collection args)
                              throws DynamicError
Matches operation.

Parameters:
args - Result from the expressions evaluation.
Returns:
Result of fn:matches operation.
Throws:
DynamicError - Dynamic error.

expected_args

public static java.util.Collection expected_args()
Obtain a list of expected arguments.

Returns:
Result of operation.