Module datarush.library

Package com.pervasive.datarush.functions

Class FunctionDescription

java.lang.Object

com.pervasive.datarush.functions.FunctionDescription

All Implemented Interfaces:

Comparable<FunctionDescription>

public class FunctionDescription
extends Object
implements Comparable<FunctionDescription>

A description of a function, including its name, description, and argument names.

Constructor Summary

Constructors

Constructor	Description
FunctionDescription(String name, String description, String category, String[] arguments, String[] argumentDescriptions)

Method Summary

Modifier and Type	Method	Description
int	compareTo(FunctionDescription o)
String[]	getArgumentDescriptions()
String[]	getArguments()
String	getCategory()
String	getDescription()
String	getName()
String	getToolTipText()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionDescription

public FunctionDescription(String name,
                           String description,
                           String category,
                           String[] arguments,
                           String[] argumentDescriptions)

Method Detail

getName

public String getName()

getDescription

public String getDescription()

getCategory

public String getCategory()

getArguments

public String[] getArguments()

getArgumentDescriptions

public String[] getArgumentDescriptions()

compareTo

public int compareTo(FunctionDescription o)

Specified by:

compareTo in interface Comparable<FunctionDescription>

toString

public String toString()

Overrides:

toString in class Object

getToolTipText

public String getToolTipText()