org.ucl.xpath.function
Class FnStringJoin

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

public class FnStringJoin
extends Function

Function to join strings together.

Usage: fn:string-join($arg1 as xs:string*, $arg2 as xs:string) as xs:string

This class returns a xs:string created by concatenating the members of the $arg1 sequence using $arg2 as a separator. If the value of $arg2 is the zero-length string, then the members of $arg1 are concatenated without a separator.

If the value of $arg1 is the empty sequence, the zero-length string is returned.


Field Summary
 
Fields inherited from class org.ucl.xpath.function.Function
_arity, _fl, _name
 
Constructor Summary
FnStringJoin()
          Constructor for FnStringJoin
 
Method Summary
 ResultSequence evaluate(java.util.Collection args)
          Evaluate the arguments.
static java.util.Collection expected_args()
          Calculate the expected arguments.
static ResultSequence string_join(java.util.Collection args)
          Join the arguments.
 
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

FnStringJoin

public FnStringJoin()
Constructor for FnStringJoin

Method Detail

evaluate

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

Specified by:
evaluate in class Function
Parameters:
args - are evaluated.
Returns:
The evaluation of the joining of the arguments.
Throws:
DynamicError - Dynamic error.

string_join

public static ResultSequence string_join(java.util.Collection args)
                                  throws DynamicError
Join the arguments.

Parameters:
args - are joined.
Returns:
The result of the arguments being joined together.
Throws:
DynamicError - Dynamic error.

expected_args

public static java.util.Collection expected_args()
Calculate the expected arguments.

Returns:
The expected arguments.