Enum DesktopFunctions

java.lang.Object
java.lang.Enum<DesktopFunctions>
com.blackrook.rookscript.desktop.functions.DesktopFunctions
All Implemented Interfaces:
com.blackrook.rookscript.lang.ScriptFunctionType, Serializable, Comparable<DesktopFunctions>
public enum DesktopFunctions extends Enum<DesktopFunctions> implements com.blackrook.rookscript.lang.ScriptFunctionType
Script functions for the Desktop toolkit.
Author:
Matthew Tropiano

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.blackrook.rookscript.lang.ScriptFunctionType

    com.blackrook.rookscript.lang.ScriptFunctionType.Usage

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BROWSE
     
    OPEN
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static final com.blackrook.rookscript.resolvers.ScriptFunctionResolver
    createResolver()
     
    abstract boolean
    execute(com.blackrook.rookscript.ScriptInstance scriptInstance, com.blackrook.rookscript.ScriptValue returnValue)
     
    int
    getParameterCount()
     
    com.blackrook.rookscript.lang.ScriptFunctionType.Usage
    getUsage()
     
    protected abstract com.blackrook.rookscript.lang.ScriptFunctionType.Usage
    usage()
     
    static DesktopFunctions
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static DesktopFunctions[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.blackrook.rookscript.lang.ScriptFunctionType

    name

  • Enum Constant Details

  • Method Details

    • values

      public static DesktopFunctions[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static DesktopFunctions valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • createResolver

      public static final com.blackrook.rookscript.resolvers.ScriptFunctionResolver createResolver()
      Returns:
      a function resolver that handles all of the functions in this enum.

    • getParameterCount

      public int getParameterCount()
      Specified by:
      getParameterCount in interface com.blackrook.rookscript.lang.ScriptFunctionType

    • getUsage

      public com.blackrook.rookscript.lang.ScriptFunctionType.Usage getUsage()
      Specified by:
      getUsage in interface com.blackrook.rookscript.lang.ScriptFunctionType

    • execute

      public abstract boolean execute(com.blackrook.rookscript.ScriptInstance scriptInstance, com.blackrook.rookscript.ScriptValue returnValue)
      Specified by:
      execute in interface com.blackrook.rookscript.lang.ScriptFunctionType

    • usage

      protected abstract com.blackrook.rookscript.lang.ScriptFunctionType.Usage usage()