org.jruby.runtime

Class Signature

java.lang.Object

org.jruby.runtime.Signature

public class Signature
extends Object

A representation of a Ruby method signature (argument layout, min/max, keyword layout, rest args).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Signature.Rest

Field Summary

Fields

Modifier and Type	Field and Description
static Signature	NO_ARGUMENTS
static Signature	ONE_ARGUMENT
static Signature	ONE_REQUIRED
static Signature	OPTIONAL
static Signature	THREE_ARGUMENTS
static Signature	THREE_REQUIRED
static Signature	TWO_ARGUMENTS
static Signature	TWO_REQUIRED

Constructor Summary

Constructors

Constructor and Description
Signature(int pre, int opt, int post, Signature.Rest rest, int kwargs, int requiredKwargs, boolean restKwargs)

Method Summary

Methods

Modifier and Type	Method and Description
Arity	arity()
int	arityValue() Best attempt at breaking the code of arity values! We figure out how many fixed/required parameters must be supplied.
void	checkArity(Ruby runtime, IRubyObject[] args)
static Signature	decode(long l)
long	encode()
static Signature	from(ArgsNode args)
static Signature	from(Arity arity)
static Signature	from(ForNode iter)
static Signature	from(int pre, int opt, int post, int kwargs, int requiredKwargs, Signature.Rest rest, boolean restKwargs)
static Signature	from(IterNode iter)
static Signature	from(PostExeNode iter)
static Signature	from(PreExeNode iter)
int	getRequiredKeywordForArityCount()
boolean	hasKwargs()
boolean	hasRest()
boolean	isFixed() Are there an exact (fixed) number of parameters to this signature?
int	opt()
int	post()
int	pre()
int	required()
Signature.Rest	rest()
boolean	restKwargs()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_ARGUMENTS

public static final Signature NO_ARGUMENTS

ONE_ARGUMENT

public static final Signature ONE_ARGUMENT

TWO_ARGUMENTS

public static final Signature TWO_ARGUMENTS

THREE_ARGUMENTS

public static final Signature THREE_ARGUMENTS

OPTIONAL

public static final Signature OPTIONAL

ONE_REQUIRED

public static final Signature ONE_REQUIRED

TWO_REQUIRED

public static final Signature TWO_REQUIRED

THREE_REQUIRED

public static final Signature THREE_REQUIRED

Constructor Detail

Signature

public Signature(int pre,
         int opt,
         int post,
         Signature.Rest rest,
         int kwargs,
         int requiredKwargs,
         boolean restKwargs)

Method Detail

getRequiredKeywordForArityCount

public int getRequiredKeywordForArityCount()

restKwargs

public boolean restKwargs()

pre

public int pre()

opt

public int opt()

rest

public Signature.Rest rest()

post

public int post()

hasKwargs

public boolean hasKwargs()

hasRest

public boolean hasRest()

isFixed

public boolean isFixed()

Are there an exact (fixed) number of parameters to this signature?

required

public int required()

arity

public Arity arity()

arityValue

public int arityValue()

Best attempt at breaking the code of arity values! We figure out how many fixed/required parameters must be supplied. Then we figure out if we need to mark the value as optional. Optional is indicated by multiplying -1 * (fixed + 1). Keyword args optional and rest values can indicate this optional condition but only if no required keyword arguments are present.

from

public static Signature from(Arity arity)

from

public static Signature from(int pre,
             int opt,
             int post,
             int kwargs,
             int requiredKwargs,
             Signature.Rest rest,
             boolean restKwargs)

from

public static Signature from(ArgsNode args)

from

public static Signature from(IterNode iter)

from

public static Signature from(ForNode iter)

from

public static Signature from(PreExeNode iter)

from

public static Signature from(PostExeNode iter)

encode

public long encode()

decode

public static Signature decode(long l)

toString

public String toString()

Overrides:

toString in class Object

checkArity

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