Package org.jruby.ast.util

Class ArgsUtil

java.lang.Object

org.jruby.ast.util.ArgsUtil

public final class ArgsUtil
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final RubyHash.VisitorWithState<Set<RubySymbol>>	MULTI_KEY_CHECK_VISITOR
static final RubyHash.VisitorWithState<RubySymbol>	SINGLE_KEY_CHECK_VISITOR

Constructor Summary

Constructors

Constructor	Description
ArgsUtil()

Method Summary

Modifier and Type	Method	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, String keyword, RubyHash opts)	Semi-deprecated, kept for compatibility.
static IRubyObject	extractKeywordArg(ThreadContext context, String keyword, IRubyObject arg)	Semi-deprecated, kept for compatibility.
static IRubyObject	extractKeywordArg(ThreadContext context, String keyword, IRubyObject... args)	Semi-deprecated, kept for compatibility.
static IRubyObject	extractKeywordArg(ThreadContext context, RubyHash options, String validKey)	Same as extractKeywordArgs(ThreadContext, RubyHash, String...).
static IRubyObject	extractKeywordArg(ThreadContext context, IRubyObject maybeKwargs, String validKey)
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[]	extractKeywordArgs(ThreadContext context, IRubyObject[] args, String... validKeys)	Deprecated.
static IRubyObject[]	extractKeywordArgs(ThreadContext context, IRubyObject maybeKwargs, String... validKeys)
static RubyHash	extractKeywords(IRubyObject possiblyKeywordArg)
static IRubyObject	getFreezeOpt(ThreadContext context, IRubyObject maybeOpts)
static IRubyObject	getOptionsArg(Ruby runtime, IRubyObject arg)	Deprecated.
static IRubyObject	getOptionsArg(Ruby runtime, IRubyObject... args)
static IRubyObject	getOptionsArg(Ruby runtime, IRubyObject arg, boolean raise)
static IRubyObject	getOptionsArg(ThreadContext context, IRubyObject arg)
static boolean	hasExceptionOption(ThreadContext context, IRubyObject options, boolean defaultValue)

Methods inherited from class java.lang.Object

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

Field Details

SINGLE_KEY_CHECK_VISITOR

public static final RubyHash.VisitorWithState<RubySymbol> SINGLE_KEY_CHECK_VISITOR

MULTI_KEY_CHECK_VISITOR

public static final RubyHash.VisitorWithState<Set<RubySymbol>> MULTI_KEY_CHECK_VISITOR

Constructor Details

ArgsUtil

public ArgsUtil()

Method Details

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)

hasExceptionOption

public static boolean hasExceptionOption(ThreadContext context,
 IRubyObject options,
 boolean defaultValue)

getOptionsArg

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

getOptionsArg

@Deprecated(since="10.0")
public static IRubyObject getOptionsArg(Ruby runtime,
 IRubyObject arg)

Deprecated.

getOptionsArg

public static IRubyObject getOptionsArg(ThreadContext context,
 IRubyObject arg)

getOptionsArg

public static IRubyObject getOptionsArg(Ruby runtime,
 IRubyObject arg,
 boolean raise)

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

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

Deprecated.

extractKeywordArgs

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

extractKeywordArg

public static IRubyObject extractKeywordArg(ThreadContext context,
 IRubyObject maybeKwargs,
 String validKey)

extractKeywordArg

public static IRubyObject extractKeywordArg(ThreadContext context,
 RubyHash options,
 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,
 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,
 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,
 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)

extractKeywords

public static RubyHash extractKeywords(IRubyObject possiblyKeywordArg)

getFreezeOpt

public static IRubyObject getFreezeOpt(ThreadContext context,
 IRubyObject maybeOpts)