Package org.jruby.runtime

Class ArgumentDescriptor

java.lang.Object

org.jruby.runtime.ArgumentDescriptor

public class ArgumentDescriptor
extends Object

A description of a single argument in a Ruby argument list. Primarily used in Method.to_proc.

Field Summary

Fields

Modifier and Type	Field	Description
static final ArgumentDescriptor[]	ANON_REST
static final ArgumentDescriptor[]	EMPTY_ARRAY
final RubySymbol	name	The name of the argument
static final ArgumentDescriptor[]	SYMBOL_PROC
final ArgumentType	type	The type of the argument

Constructor Summary

Constructors

Constructor	Description
ArgumentDescriptor(ArgumentType type)
ArgumentDescriptor(ArgumentType type, RubySymbol name)

Method Summary

Modifier and Type	Method	Description
RubyString	asParameterName(ThreadContext context)
static ArgumentDescriptor[]	decode(Ruby runtime, String encodedDescriptors)	Translate encoded String of argument descriptors back into an ArgumentDescriptor list
static String	encode(ArgumentDescriptor[] descriptors)	Allow JIT/AOT to store argument descriptors as a single String constant.
final RubyArray	toArrayForm(Ruby runtime, boolean isLambda)	Deprecated.
final RubyArray	toArrayForm(ThreadContext context, boolean isLambda)

Methods inherited from class java.lang.Object

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

Field Details

type

public final ArgumentType type

The type of the argument

name

public final RubySymbol name

The name of the argument

EMPTY_ARRAY

public static final ArgumentDescriptor[] EMPTY_ARRAY

ANON_REST

public static final ArgumentDescriptor[] ANON_REST

SYMBOL_PROC

public static final ArgumentDescriptor[] SYMBOL_PROC

Constructor Details

ArgumentDescriptor

public ArgumentDescriptor(ArgumentType type,
 RubySymbol name)

ArgumentDescriptor

public ArgumentDescriptor(ArgumentType type)

Method Details

toArrayForm

@Deprecated(since="10.0")
public final RubyArray toArrayForm(Ruby runtime,
 boolean isLambda)

Deprecated.

toArrayForm

public final RubyArray toArrayForm(ThreadContext context,
 boolean isLambda)

asParameterName

public RubyString asParameterName(ThreadContext context)

encode

public static String encode(ArgumentDescriptor[] descriptors)

Allow JIT/AOT to store argument descriptors as a single String constant.

Parameters:

descriptors - the list to convert into a string

Returns:

the encoded descriptors

decode

public static ArgumentDescriptor[] decode(Ruby runtime,
 String encodedDescriptors)

Translate encoded String of argument descriptors back into an ArgumentDescriptor list

Parameters:

runtime - to reify ids back into symbols

encodedDescriptors - the encoded String

Returns:

an array of descriptors