com.mockturtlesolutions.snifflib.spreadsheets

Class GroovyScriptReservedFunction

java.lang.Object

com.mockturtlesolutions.snifflib.spreadsheets.GroovyScriptReservedFunction

All Implemented Interfaces:

ReservedFunction, java.lang.Comparable

public class GroovyScriptReservedFunction
extends java.lang.Object
implements ReservedFunction

A ReservedFunction which is backed by a script representing valid Groovy code.

Constructor Summary

Constructors

Constructor and Description
GroovyScriptReservedFunction(java.lang.String shortnam, DefaultSpreadsheetEntry ent, DefaultSpreadsheetTable pt, DefaultSpreadsheetPanel pp)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object c)
java.lang.Object	evaluate(java.lang.Object[] args, DefaultSpreadsheetPanel p, DefaultSpreadsheetTable t)
int	getArgCount()
java.lang.String	getCategory()
java.lang.String	getComment() Returns examples string.
java.lang.String	getDescription()
int	getMaxArgCount() Sets the minimum number of arguments.
int	getMinArgCount() Sets the minimum number of arguments.
java.lang.String	getName()
void	setArgCount(int n)
void	setCategory(java.lang.String s)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mockturtlesolutions.snifflib.spreadsheets.ReservedFunction

toString

Constructor Detail

GroovyScriptReservedFunction

public GroovyScriptReservedFunction(java.lang.String shortnam,
                            DefaultSpreadsheetEntry ent,
                            DefaultSpreadsheetTable pt,
                            DefaultSpreadsheetPanel pp)

Method Detail

getMaxArgCount

public int getMaxArgCount()

Description copied from interface: ReservedFunction

Sets the minimum number of arguments. This default implementation returns a value of 1.

Specified by:

getMaxArgCount in interface ReservedFunction

getComment

public java.lang.String getComment()

Returns examples string. This default convenience implementation returns null.

Specified by:

getComment in interface ReservedFunction

getMinArgCount

public int getMinArgCount()

Description copied from interface: ReservedFunction

Sets the minimum number of arguments. A value of -1 implies no minimum constraint. Note, a value of -1 is operationally equivalent to a value of zero in this case. This default implementation returns a value of 1.

Specified by:

getMinArgCount in interface ReservedFunction

getName

public java.lang.String getName()

Specified by:

getName in interface ReservedFunction

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface ReservedFunction

evaluate

public java.lang.Object evaluate(java.lang.Object[] args,
                        DefaultSpreadsheetPanel p,
                        DefaultSpreadsheetTable t)

Specified by:

evaluate in interface ReservedFunction

getCategory

public java.lang.String getCategory()

Specified by:

getCategory in interface ReservedFunction

setCategory

public void setCategory(java.lang.String s)

setArgCount

public void setArgCount(int n)

Specified by:

setArgCount in interface ReservedFunction

getArgCount

public int getArgCount()

Specified by:

getArgCount in interface ReservedFunction

compareTo

public int compareTo(java.lang.Object c)

Specified by:

compareTo in interface ReservedFunction

Specified by:

compareTo in interface java.lang.Comparable