Package org.jruby.runtime

Class Arity

java.lang.Object

org.jruby.runtime.Arity

All Implemented Interfaces:

Serializable

public final class Arity
extends Object
implements Serializable

The arity of a method is the number of arguments it takes.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Arity	NO_ARGUMENTS
static final Arity	ONE_ARGUMENT
static final Arity	ONE_REQUIRED
static final Arity	OPTIONAL
static final Arity	THREE_ARGUMENTS
static final Arity	THREE_REQUIRED
static final Arity	TWO_ARGUMENTS
static final Arity	TWO_REQUIRED
static final int	UNLIMITED_ARGUMENTS

Method Summary

Modifier and Type	Method	Description
static int	checkArgumentCount(Ruby runtime, int length, int min, int max)	Deprecated.
static int	checkArgumentCount(Ruby runtime, int length, int min, int max, boolean hasKwargs)	Deprecated.
static int	checkArgumentCount(Ruby runtime, String name, int length, int min, int max)	Deprecated.
static int	checkArgumentCount(Ruby runtime, String name, int length, int min, int max, boolean hasKwargs)
static int	checkArgumentCount(Ruby runtime, String name, IRubyObject[] args, int min, int max)	Deprecated.
static int	checkArgumentCount(Ruby runtime, IRubyObject[] args, int min, int max)	Deprecated.
static int	checkArgumentCount(ThreadContext context, int length, int min, int max)
static int	checkArgumentCount(ThreadContext context, int length, int min, int max, boolean hasKwargs)
static int	checkArgumentCount(ThreadContext context, String name, int length, int min, int max)
static int	checkArgumentCount(ThreadContext context, String name, IRubyObject[] args, int min, int max)
static int	checkArgumentCount(ThreadContext context, IRubyObject[] args, int min, int max)
void	checkArity(Ruby runtime, int length)
void	checkArity(Ruby runtime, IRubyObject[] args)
static Arity	createArity(int value)
boolean	equals(Object other)
static Arity	fixed(int arity)
static Arity	fromAnnotation(JRubyMethod anno)
static Arity	fromAnnotation(JRubyMethod anno, int required)
static Arity	fromAnnotation(JRubyMethod anno, Class[] parameterTypes, boolean isStatic)
int	getValue()
int	hashCode()
boolean	isFixed()
static Arity	noArguments()
static Arity	optional()
static void	raiseArgumentError(Ruby runtime, int length, int min, int max)	Deprecated.
static void	raiseArgumentError(Ruby runtime, int length, int min, int max, boolean hasKwargs)	Deprecated.
static void	raiseArgumentError(Ruby runtime, String name, int length, int min, int max)	Deprecated.
static void	raiseArgumentError(Ruby runtime, String name, int length, int min, int max, boolean hasKwargs)
static void	raiseArgumentError(Ruby runtime, IRubyObject[] args, int min, int max)	Deprecated.
static void	raiseArgumentError(ThreadContext context, int length, int min, int max)
static void	raiseArgumentError(ThreadContext context, int length, int min, int max, boolean hasKwargs)
static void	raiseArgumentError(ThreadContext context, String name, int length, int min, int max)
static void	raiseArgumentError(ThreadContext context, IRubyObject[] args, int min, int max)
int	required()
static Arity	required(int minimum)
static IRubyObject[]	scanArgs(Ruby runtime, IRubyObject[] args, int required, int optional)	Deprecated.
static IRubyObject[]	scanArgs(ThreadContext context, IRubyObject[] args, int required, int optional)
static Arity	singleArgument()
String	toString()
static Arity	twoArguments()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NO_ARGUMENTS

public static final Arity NO_ARGUMENTS

ONE_ARGUMENT

public static final Arity ONE_ARGUMENT

TWO_ARGUMENTS

public static final Arity TWO_ARGUMENTS

THREE_ARGUMENTS

public static final Arity THREE_ARGUMENTS

OPTIONAL

public static final Arity OPTIONAL

ONE_REQUIRED

public static final Arity ONE_REQUIRED

TWO_REQUIRED

public static final Arity TWO_REQUIRED

THREE_REQUIRED

public static final Arity THREE_REQUIRED

UNLIMITED_ARGUMENTS

public static final int UNLIMITED_ARGUMENTS

See Also:

• Constant Field Values

Method Details

createArity

public static Arity createArity(int value)

fromAnnotation

public static Arity fromAnnotation(JRubyMethod anno)

fromAnnotation

public static Arity fromAnnotation(JRubyMethod anno,
 int required)

fromAnnotation

public static Arity fromAnnotation(JRubyMethod anno,
 Class[] parameterTypes,
 boolean isStatic)

fixed

public static Arity fixed(int arity)

optional

public static Arity optional()

required

public static Arity required(int minimum)

noArguments

public static Arity noArguments()

singleArgument

public static Arity singleArgument()

twoArguments

public static Arity twoArguments()

getValue

public int getValue()

checkArity

public void checkArity(Ruby runtime,
 IRubyObject[] args)

checkArity

public void checkArity(Ruby runtime,
 int length)

isFixed

public boolean isFixed()

required

public int required()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

checkArgumentCount

public static int checkArgumentCount(ThreadContext context,
 IRubyObject[] args,
 int min,
 int max)

checkArgumentCount

public static int checkArgumentCount(ThreadContext context,
 String name,
 IRubyObject[] args,
 int min,
 int max)

checkArgumentCount

public static int checkArgumentCount(ThreadContext context,
 int length,
 int min,
 int max)

checkArgumentCount

public static int checkArgumentCount(ThreadContext context,
 int length,
 int min,
 int max,
 boolean hasKwargs)

checkArgumentCount

public static int checkArgumentCount(ThreadContext context,
 String name,
 int length,
 int min,
 int max)

checkArgumentCount

public static int checkArgumentCount(Ruby runtime,
 String name,
 int length,
 int min,
 int max,
 boolean hasKwargs)

raiseArgumentError

public static void raiseArgumentError(ThreadContext context,
 int length,
 int min,
 int max)

raiseArgumentError

public static void raiseArgumentError(ThreadContext context,
 IRubyObject[] args,
 int min,
 int max)

raiseArgumentError

public static void raiseArgumentError(ThreadContext context,
 int length,
 int min,
 int max,
 boolean hasKwargs)

raiseArgumentError

public static void raiseArgumentError(ThreadContext context,
 String name,
 int length,
 int min,
 int max)

raiseArgumentError

public static void raiseArgumentError(Ruby runtime,
 String name,
 int length,
 int min,
 int max,
 boolean hasKwargs)

scanArgs

@Deprecated(since="10.0")
public static IRubyObject[] scanArgs(Ruby runtime,
 IRubyObject[] args,
 int required,
 int optional)

Deprecated.

scanArgs

public static IRubyObject[] scanArgs(ThreadContext context,
 IRubyObject[] args,
 int required,
 int optional)

checkArgumentCount

@Deprecated
public static int checkArgumentCount(Ruby runtime,
 IRubyObject[] args,
 int min,
 int max)

Deprecated.

checkArgumentCount

@Deprecated
public static int checkArgumentCount(Ruby runtime,
 String name,
 IRubyObject[] args,
 int min,
 int max)

Deprecated.

checkArgumentCount

@Deprecated
public static int checkArgumentCount(Ruby runtime,
 int length,
 int min,
 int max)

Deprecated.

checkArgumentCount

@Deprecated
public static int checkArgumentCount(Ruby runtime,
 int length,
 int min,
 int max,
 boolean hasKwargs)

Deprecated.

checkArgumentCount

@Deprecated
public static int checkArgumentCount(Ruby runtime,
 String name,
 int length,
 int min,
 int max)

Deprecated.

raiseArgumentError

@Deprecated
public static void raiseArgumentError(Ruby runtime,
 IRubyObject[] args,
 int min,
 int max)

Deprecated.

raiseArgumentError

@Deprecated
public static void raiseArgumentError(Ruby runtime,
 int length,
 int min,
 int max)

Deprecated.

raiseArgumentError

@Deprecated
public static void raiseArgumentError(Ruby runtime,
 int length,
 int min,
 int max,
 boolean hasKwargs)

Deprecated.

raiseArgumentError

@Deprecated
public static void raiseArgumentError(Ruby runtime,
 String name,
 int length,
 int min,
 int max)

Deprecated.