org.jruby.ast.util

Class ArgsUtil

java.lang.Object

org.jruby.ast.util.ArgsUtil

public final class ArgsUtil
extends Object

Author:

jpetersen

Constructor Summary

Constructors

Constructor and Description
ArgsUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static int	arrayLength(IRubyObject node)
static IRubyObject[]	convertToJavaArray(IRubyObject value)
static RubyArray	convertToRubyArray(Ruby runtime, IRubyObject value, boolean coerce) This name may be a bit misleading, since this also attempts to coerce array behavior using to_ary.
static RubyArray	convertToRubyArray19(Ruby runtime, IRubyObject value, boolean coerce)
static RubyArray	convertToRubyArrayWithCoerce(Ruby runtime, IRubyObject value)
static RubyArray	convertToRubyArrayWithCoerce19(Ruby runtime, IRubyObject value)
static IRubyObject[]	extractKeywordArgs(ThreadContext context, IRubyObject[] args, String[] validKeys)
static IRubyObject[]	extractKeywordArgs(ThreadContext context, RubyHash options, String[] validKeys) Check that the given kwargs hash doesn't contain any keys other than those which are given as valid.
static IRubyObject	getOptionsArg(Ruby runtime, IRubyObject... args)
static IRubyObject[]	popArray(IRubyObject[] array) Remove first element from array

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgsUtil

public ArgsUtil()

Method Detail

convertToJavaArray

public static IRubyObject[] convertToJavaArray(IRubyObject value)

convertToRubyArray

public static RubyArray convertToRubyArray(Ruby runtime,
                           IRubyObject value,
                           boolean coerce)

This name may be a bit misleading, since this also attempts to coerce array behavior using to_ary.

Parameters:

runtime - The JRuby runtime

value - The value to convert

coerce - Whether to coerce using to_ary or just wrap with an array

convertToRubyArrayWithCoerce

public static RubyArray convertToRubyArrayWithCoerce(Ruby runtime,
                                     IRubyObject value)

convertToRubyArray19

public static RubyArray convertToRubyArray19(Ruby runtime,
                             IRubyObject value,
                             boolean coerce)

convertToRubyArrayWithCoerce19

public static RubyArray convertToRubyArrayWithCoerce19(Ruby runtime,
                                       IRubyObject value)

popArray

public static IRubyObject[] popArray(IRubyObject[] array)

Remove first element from array

Parameters:

array - to have first element "popped" off

Returns:

all but first element of the supplied array

arrayLength

public static int arrayLength(IRubyObject node)

getOptionsArg

public static IRubyObject getOptionsArg(Ruby runtime,
                        IRubyObject... args)

extractKeywordArgs

public static IRubyObject[] extractKeywordArgs(ThreadContext context,
                               RubyHash options,
                               String[] validKeys)

Check that the given kwargs hash doesn't contain any keys other than those which are given as valid.

Parameters:

context - The context to execute in

options - A RubyHash of options to extract kwargs from

validKeys - A list of valid kwargs keys.

Returns:

an array of objects corresponding to the given keys.

extractKeywordArgs

public static IRubyObject[] extractKeywordArgs(ThreadContext context,
                               IRubyObject[] args,
                               String[] validKeys)