Class FunInfo

  • All Implemented Interfaces:
    java.lang.Comparable<FunInfo>

    public class FunInfo
    extends java.lang.Object
    implements java.lang.Comparable<FunInfo>
    Support class for the CmdRunner allowing one to view available functions and their syntax.
    Author:
    Richard M. Emberson
    • Constructor Detail

      • FunInfo

        FunInfo​(FunDef funDef)
      • FunInfo

        FunInfo​(Resolver resolver)
      • FunInfo

        FunInfo​(java.lang.String name,
                java.lang.String description,
                java.lang.String flags)
    • Method Detail

      • getSignatures

        public java.lang.String[] getSignatures()
      • getSyntax

        public Syntax getSyntax()
        Returns the syntactic type of the function.
      • getName

        public java.lang.String getName()
        Returns the name of this function.
      • getDescription

        public java.lang.String getDescription()
        Returns the description of this function.
      • getReturnCategories

        public int[] getReturnCategories()
        Returns the type of value returned by this function. Values are the same as those returned by Exp.getCategory().
      • getParameterCategories

        public int[][] getParameterCategories()
        Returns the types of the arguments of this function. Values are the same as those returned by 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.
      • compareTo

        public int compareTo​(FunInfo fi)
        Specified by:
        compareTo in interface java.lang.Comparable<FunInfo>
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object