com.sleepycat.dbxml
Class XmlArguments

java.lang.Object
  com.sleepycat.dbxml.XmlArguments

public class XmlArguments
extends Object

The XmlArguments class is used by implementors of XmlExternalFunction to access function arguments passed to the XmlExternalFunction.execute(com.sleepycat.dbxml.XmlTransaction, com.sleepycat.dbxml.XmlManager, com.sleepycat.dbxml.XmlArguments) method.

Constructor Summary

XmlArguments()

Method Summary

void	delete() Releases the native resources associated with this object.
XmlResults	getArgument(int index) Gets the argument at the specified index.
long	getNumberOfArgs() Gets the number of arguments available in the object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlArguments

public XmlArguments()

Method Detail

delete

public void delete()

Releases the native resources associated with this object.

getArgument

public XmlResults getArgument(int index)
                       throws XmlException

Gets the argument at the specified index.

Parameters:

index - The index for the desired argument, zero-based.

Returns:

An XmlResults containing the argument values.

Throws:

XmlException

getNumberOfArgs

public long getNumberOfArgs()
                     throws XmlException

Gets the number of arguments available in the object.

Returns:

The number of arguments.

Throws:

XmlException