org.jruby.ast.util

Class ArgsUtil

java.lang.Object

org.jruby.ast.util.ArgsUtil

public final class ArgsUtil
extends java.lang.Object

Author:

jpetersen

Constructor Summary

Constructors

Constructor and Description
ArgsUtil()

Method Summary

Modifier and Type	Method and Description
static int	arrayLength(IRubyObject node)
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	convertToRubyArrayWithCoerce(Ruby runtime, IRubyObject value)
static IRubyObject	extractKeywordArg(ThreadContext context, RubyHash options, java.lang.String validKey) Same as extractKeywordArgs(ThreadContext, RubyHash, String...).
static IRubyObject	extractKeywordArg(ThreadContext context, java.lang.String keyword, IRubyObject... args) Semi-deprecated, kept for compatibility.
static IRubyObject	extractKeywordArg(ThreadContext context, java.lang.String keyword, IRubyObject arg) Semi-deprecated, kept for compatibility.
static IRubyObject	extractKeywordArg(ThreadContext context, java.lang.String keyword, RubyHash opts) Semi-deprecated, kept for compatibility.
static IRubyObject[]	extractKeywordArgs(ThreadContext context, IRubyObject[] args, java.lang.String... validKeys)
static IRubyObject[]	extractKeywordArgs(ThreadContext context, RubyHash options, java.lang.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	getOptionsArg(Ruby runtime, IRubyObject arg)

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

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)

arrayLength

public static int arrayLength(IRubyObject node)

getOptionsArg

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

getOptionsArg

public static IRubyObject getOptionsArg(Ruby runtime,
                                        IRubyObject arg)

extractKeywordArgs

public static IRubyObject[] extractKeywordArgs(ThreadContext context,
                                               RubyHash options,
                                               java.lang.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,
                                               java.lang.String... validKeys)

extractKeywordArg

public static IRubyObject extractKeywordArg(ThreadContext context,
                                            RubyHash options,
                                            java.lang.String validKey)

Same as extractKeywordArgs(ThreadContext, RubyHash, String...).

Parameters:

context -

options -

validKey - the keyword to extract

Returns:

null if key not within options, otherwise options[:keyword]

extractKeywordArg

public static IRubyObject extractKeywordArg(ThreadContext context,
                                            java.lang.String keyword,
                                            RubyHash opts)

Semi-deprecated, kept for compatibility. Compared to extractKeywordArg(ThreadContext, RubyHash, String) does not validate options!

Parameters:

context -

keyword -

opts -

Returns:

nil if key not within options (no way to distinguish a key: nil and missing key)

extractKeywordArg

public static IRubyObject extractKeywordArg(ThreadContext context,
                                            java.lang.String keyword,
                                            IRubyObject arg)

Semi-deprecated, kept for compatibility. Compared to extractKeywordArg(ThreadContext, RubyHash, String) does not validate options!

Parameters:

context -

keyword -

arg -

Returns:

nil if key not within options (no way to distinguish a key: nil and missing key)

extractKeywordArg

public static IRubyObject extractKeywordArg(ThreadContext context,
                                            java.lang.String keyword,
                                            IRubyObject... args)

Semi-deprecated, kept for compatibility. Compared to extractKeywordArg(ThreadContext, RubyHash, String) does not validate options!

Parameters:

context -

keyword -

args -

Returns:

nil if key not within options (no way to distinguish a key: nil and missing key)