io.apigee.trireme.core

Class ArgUtils

java.lang.Object

io.apigee.trireme.core.ArgUtils

public class ArgUtils
extends Object

This is a set of handy functions for parsing JavaScript arguments in JavaCode. We use it in conjuntion with the Rhino methods for creating a function that takes a variable argument list, which passes an array of Objects.

Constructor Summary

Constructors

Constructor and Description
ArgUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	booleanArg(Object[] args, int pos) Return the argument at "pos" as a boolean, or throw an exception if the argument list is not long enough.
static boolean	booleanArg(Object[] args, int pos, boolean def) Return the argument at "pos" as a boolean, or return "def" if the argument list is not long enough.
static double	doubleArg(Object[] args, int pos) Return the argument at "pos" as a double, or throw an exception if the argument list is not long enough.
static double	doubleArg(Object[] args, int pos, double def) Return the argument at "pos" as a double, or return "def" if the argument list is not long enough.
static void	ensureArg(Object[] args, int pos) Throw an execption if the argument list isn't long enough for argument "pos".
static org.mozilla.javascript.Scriptable	ensureValid(Object obj) Return the object, or null if it is "not found" or undefined.
static float	floatArg(Object[] args, int pos) Return the argument at "pos" as a float, or throw an exception if the argument list is not long enough.
static float	floatArg(Object[] args, int pos, float def) Return the argument at "pos" as a float, or return "def" if the argument list is not long enough.
static org.mozilla.javascript.Function	functionArg(Object[] args, int pos, boolean required) Deprecated.
static int	intArg(Object[] args, int pos) Return the argument at "pos" as an int, or throw an exception if the argument list is not long enough.
static int	intArg(Object[] args, int pos, int def) Return the argument at "pos" as an int, or return "def" if the argument list is not long enough.
static int	intArgOnly(org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable scope, Object[] args, int pos, int def) Return the argument at "pos" as a Number, or throw an exception if the argument list is not long enough.
static int	intArgOnly(Object[] args, int pos) Deprecated.
static boolean	isIntArg(Object o) Return if the specified argument is either a Number, or a String that could be converted to a number.
static long	longArg(Object[] args, int pos) Return the argument at "pos" as a long, or throw an exception if the argument list is not long enough.
static long	longArg(Object[] args, int pos, long def) Return the argument at "pos" as a long, or return "def" if the argument list is not long enough.
static long	longArgOnly(org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable scope, Object[] args, int pos, long def) Return the argument at "pos" as a long, or return "def" if the argument list is not long enough.
static Number	numberArg(Object[] args, int pos) Return the argument at "pos" as a Number, or throw an exception if the argument list is not long enough.
static <T> T	objArg(org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable scope, Object[] args, int pos, Class<T> type, boolean required) Return the argument at "pos" as a member of the specified Java class, and throw an exception if "required" and the list is too short.
static <T> T	objArg(Object[] args, int pos, Class<T> type, boolean required) Deprecated.
static int	octalOrHexIntArg(Object[] args, int pos) Return the argument at "pos" as an int, or throw an exception if the argument list is not long enough.
static int	octalOrHexIntArg(Object[] args, int pos, int def) Return the argument at "pos" as an int, or return "def" if the argument list is not long enough.
static int	parseUnsignedIntForgiveably(Object o) Some Node code expects us to be very forgiving with integers.
static String	stringArg(Object[] args, int pos) Return the argument at "pos" as a String, or throw an exception if the argument list is not long enough.
static String	stringArg(Object[] args, int pos, String def) Return the argument at "pos" as a String, or return "def" if the argument list is not long enough.
static int	toInt(Object o) Turn an object into an integer if we can.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgUtils

public ArgUtils()

Method Detail

toInt

public static int toInt(Object o)

Turn an object into an integer if we can.

ensureArg

public static void ensureArg(Object[] args,
             int pos)

Throw an execption if the argument list isn't long enough for argument "pos".

stringArg

public static String stringArg(Object[] args,
               int pos)

Return the argument at "pos" as a String, or throw an exception if the argument list is not long enough.

stringArg

public static String stringArg(Object[] args,
               int pos,
               String def)

Return the argument at "pos" as a String, or return "def" if the argument list is not long enough.

intArg

public static int intArg(Object[] args,
         int pos)

Return the argument at "pos" as an int, or throw an exception if the argument list is not long enough.

intArg

public static int intArg(Object[] args,
         int pos,
         int def)

Return the argument at "pos" as an int, or return "def" if the argument list is not long enough.

octalOrHexIntArg

public static int octalOrHexIntArg(Object[] args,
                   int pos)

Return the argument at "pos" as an int, or throw an exception if the argument list is not long enough. Convert the argument if it is octal (starting with a '0') or hex (starting with "0x").

octalOrHexIntArg

public static int octalOrHexIntArg(Object[] args,
                   int pos,
                   int def)

Return the argument at "pos" as an int, or return "def" if the argument list is not long enough. Convert the argument if it is octal (starting with a '0') or hex (starting with "0x").

numberArg

public static Number numberArg(Object[] args,
               int pos)

Return the argument at "pos" as a Number, or throw an exception if the argument list is not long enough.

intArgOnly

@Deprecated
public static int intArgOnly(Object[] args,
                        int pos)

Deprecated.

Return the argument at "pos" as an int, or throw an exception if the argument list is not long enough. If the argument is not an integer (aka it is floating-point) then throw an exception.

intArgOnly

public static int intArgOnly(org.mozilla.javascript.Context cx,
             org.mozilla.javascript.Scriptable scope,
             Object[] args,
             int pos,
             int def)

Return the argument at "pos" as a Number, or throw an exception if the argument list is not long enough. If the argument is not an integer (aka it is floating-point) then throw an exception.

longArg

public static long longArg(Object[] args,
           int pos)

Return the argument at "pos" as a long, or throw an exception if the argument list is not long enough.

longArg

public static long longArg(Object[] args,
           int pos,
           long def)

Return the argument at "pos" as a long, or return "def" if the argument list is not long enough.

longArgOnly

public static long longArgOnly(org.mozilla.javascript.Context cx,
               org.mozilla.javascript.Scriptable scope,
               Object[] args,
               int pos,
               long def)

Return the argument at "pos" as a long, or return "def" if the argument list is not long enough. If the argument is not an integer (aka it is floating-point) then throw an exception.

booleanArg

public static boolean booleanArg(Object[] args,
                 int pos)

Return the argument at "pos" as a boolean, or throw an exception if the argument list is not long enough.

booleanArg

public static boolean booleanArg(Object[] args,
                 int pos,
                 boolean def)

Return the argument at "pos" as a boolean, or return "def" if the argument list is not long enough.

floatArg

public static float floatArg(Object[] args,
             int pos)

Return the argument at "pos" as a float, or throw an exception if the argument list is not long enough.

floatArg

public static float floatArg(Object[] args,
             int pos,
             float def)

Return the argument at "pos" as a float, or return "def" if the argument list is not long enough.

doubleArg

public static double doubleArg(Object[] args,
               int pos)

Return the argument at "pos" as a double, or throw an exception if the argument list is not long enough.

doubleArg

public static double doubleArg(Object[] args,
               int pos,
               double def)

Return the argument at "pos" as a double, or return "def" if the argument list is not long enough.

functionArg

@Deprecated
public static org.mozilla.javascript.Function functionArg(Object[] args,
                                                     int pos,
                                                     boolean required)

Deprecated.

Return the argument at "pos" as a Function, and throw an exception if "required" and the list is too short.

objArg

@Deprecated
public static <T> T objArg(Object[] args,
                      int pos,
                      Class<T> type,
                      boolean required)

Deprecated.

Return the argument at "pos" as a member of the specified Java class, and throw an exception if "required" and the list is too short. This is handy when passing Java objects back to JavaScript, then getting them back and turning them back in to Java objects.

objArg

public static <T> T objArg(org.mozilla.javascript.Context cx,
           org.mozilla.javascript.Scriptable scope,
           Object[] args,
           int pos,
           Class<T> type,
           boolean required)

Return the argument at "pos" as a member of the specified Java class, and throw an exception if "required" and the list is too short. This is handy when passing Java objects back to JavaScript, then getting them back and turning them back in to Java objects.

isIntArg

public static boolean isIntArg(Object o)

Return if the specified argument is either a Number, or a String that could be converted to a number.

parseUnsignedIntForgiveably

public static int parseUnsignedIntForgiveably(Object o)

Some Node code expects us to be very forgiving with integers. From the buffer tests, for instance, we deduce that this code must: If an integer, return either a positive integer or zero. If a double, return either a positive integer rounded up, or zero If a string, parse to an integer or double and re-do the last two steps. This method returns -1 if the value is greater than MAX_VALUE for an int.

ensureValid

public static org.mozilla.javascript.Scriptable ensureValid(Object obj)

Return the object, or null if it is "not found" or undefined.