public class FunInfo extends Object implements Comparable<FunInfo>
CmdRunner
allowing one to view
available functions and their syntax.Constructor and Description |
---|
FunInfo(FunDef funDef) |
FunInfo(MultiResolver multiResolver) |
FunInfo(Resolver resolver) |
FunInfo(String name,
String description,
String flags) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(FunInfo fi) |
boolean |
equals(Object obj) |
String |
getDescription()
Returns the description of this function.
|
String |
getName()
Returns the name of this function.
|
int[][] |
getParameterCategories()
Returns the types of the arguments of this function.
|
int[] |
getReturnCategories()
Returns the type of value returned by this function.
|
String[] |
getSignatures() |
Syntax |
getSyntax()
Returns the syntactic type of the function.
|
int |
hashCode() |
(package private) static FunInfo |
make(Resolver resolver) |
FunInfo(FunDef funDef)
FunInfo(MultiResolver multiResolver)
FunInfo(Resolver resolver)
public String[] getSignatures()
public Syntax getSyntax()
public String getName()
public String getDescription()
public int[] getReturnCategories()
Exp.getCategory()
.public int[][] getParameterCategories()
Exp.getCategory()
. The
0th argument of methods and properties are the object they
are applied to. Infix operators have two arguments, and prefix operators
have one argument.public int compareTo(FunInfo fi)
compareTo
in interface Comparable<FunInfo>