|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.me.nxg.unity.FunctionDefinition
public class FunctionDefinition
Describes a function. Functions take a single unit as argument.
There are no syntax variations, beyond the set of functions which are recommended.
Method Summary | |
---|---|
int |
compareTo(Object o)
Provides a sorting order for definitions. |
String |
description()
A human-readable description of the function. |
boolean |
equals(Object o)
|
String |
fallbackName()
A fallback name for the function. |
int |
hashCode()
|
String |
latexForm()
A LaTeX form of the function name. |
String |
name()
The name of this function, or null. |
String |
toString()
Produces a representation of this function as a string. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public String description()
public String latexForm()
public int compareTo(Object o)
compareTo
in interface Comparable
public int hashCode()
hashCode
in class Object
public boolean equals(Object o)
equals
in class Object
public String toString()
UnitExpr.toString()
.
toString
in class Object
public String name()
public String fallbackName()
In fact, this is (a) only necessary for debugging purposes, because usually the overridden name() function will work, and (b) it is always (?) the same as the string eventually returned from name(), because (at present) all of the functions have the same short names in those syntaxes which know about them. This may be unnecessary generality (YAGNI, and all that), but it's essentially here for symmetry with the UnitDefinition lookup process, here and in ParseFunctions.java
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |