JRuby Base 10.0.0.0 · org.jruby.runtime.Signature · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static enum	Signature.Rest

Field Summary

Modifier and Type	Field and Description
private final int	arityValue
private static final int	ENCODE_KWARGS_SHIFT
private static final int	ENCODE_OPT_SHIFT
private static final int	ENCODE_POST_SHIFT
private static final int	ENCODE_PRE_SHIFT
private static final int	ENCODE_REQKWARGS_SHIFT
private static final int	ENCODE_REST_SHIFT
private static final int	ENCODE_RESTKWARGS_SHIFT
public static final Signature	FOUR_ARGUMENTS
public static final Signature	FOUR_REQUIRED
private final int	keyRest
private final short	kwargs
private static final int	MAX_ENCODED_ARGS_EXPONENT
private static final int	MAX_ENCODED_ARGS_MASK
public static final Signature	NO_ARGUMENTS
public static final Signature	ONE_ARGUMENT
public static final Signature	ONE_OPT_ARGUMENT
public static final Signature	ONE_REQUIRED
private final short	opt
public static final Signature	OPTIONAL
private final short	post
private final short	pre
private final short	requiredKwargs
private final Signature.Rest	rest
public static final Signature	THREE_ARGUMENTS
public static final Signature	THREE_REQUIRED
public static final Signature	TWO_ARGUMENTS
public static final Signature	TWO_REQUIRED

Constructor Summary

Access	Constructor and Description
public	Signature(int pre, int opt, int post, Signature.Rest rest, int kwargs, int requiredKwargs, int keyRest)

Method Summary

Modifier and Type	Method and Description
public Arity	arity() Deprecated
public int	arityValue()
public int	calculateArityValue() Best attempt at breaking the code of arity values!
public void	checkArity(Ruby runtime, IRubyObject[] args) Deprecated since 10.0.
public void	checkArity(ThreadContext context, IRubyObject[] args)
public static Signature	decode(long l)
public long	encode()
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static Signature	from(Arity arity) Deprecated
public static Signature	from(int pre, int opt, int post, int kwargs, int requiredKwargs, Signature.Rest rest, int keyRest)
public static Signature	from(ArgsNode args)
public static Signature	from(IterNode iter)
public static Signature	from(ForNode iter)
public static Signature	from(PreExeNode iter)
public static Signature	from(PostExeNode iter)
public static Signature	fromArityValue(int arityValue)
public int	getRequiredKeywordForArityCount()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasKwargs()
public boolean	hasRest()
public boolean	isFixed() Are there an exact (fixed) number of parameters to this signature?
public boolean	isNoArguments() Is this a signature with a no arguments of any kind?
public boolean	isOneArgument() Is this a signature with a single fixed argument and NO keyword arguments?
public boolean	Returns: true if the signature expects multiple args isSpreadable() If we are yield'ing to this signature should we spread/destructure a Ruby Array?
public boolean	isTwoArguments() Is this a signature with a two fixed arguments and NO keyword arguments?
public int	keyRest()
public int	Returns: the number of kwarg parameters kwargs() Total number of keyword argument parameters.
public int	Returns: the minimum amount of params expected. max() The maximum number of parameters supplied which can fulfill a call to this signature.
public int	Returns: the minimum amount of params expected. min() The minimum number of parameters supplied which can fulfill a call to this signature.
public int	opt()
public int	post()
public int	pre()
public int	required()
public Signature.Rest	rest()
private static Signature.Rest	restFromArg(Node restArg)
public boolean	restKwargs()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

arityValue	back to summary
private final int arityValue

ENCODE_KWARGS_SHIFT	back to summary
private static final int ENCODE_KWARGS_SHIFT

ENCODE_OPT_SHIFT	back to summary
private static final int ENCODE_OPT_SHIFT

ENCODE_POST_SHIFT	back to summary
private static final int ENCODE_POST_SHIFT

ENCODE_PRE_SHIFT	back to summary
private static final int ENCODE_PRE_SHIFT

ENCODE_REQKWARGS_SHIFT	back to summary
private static final int ENCODE_REQKWARGS_SHIFT

ENCODE_REST_SHIFT	back to summary
private static final int ENCODE_REST_SHIFT

ENCODE_RESTKWARGS_SHIFT	back to summary
private static final int ENCODE_RESTKWARGS_SHIFT

FOUR_ARGUMENTS	back to summary
public static final Signature FOUR_ARGUMENTS

FOUR_REQUIRED	back to summary
public static final Signature FOUR_REQUIRED

keyRest	back to summary
private final int keyRest

kwargs	back to summary
private final short kwargs

MAX_ENCODED_ARGS_EXPONENT	back to summary
private static final int MAX_ENCODED_ARGS_EXPONENT

MAX_ENCODED_ARGS_MASK	back to summary
private static final int MAX_ENCODED_ARGS_MASK

NO_ARGUMENTS	back to summary
public static final Signature NO_ARGUMENTS

ONE_ARGUMENT	back to summary
public static final Signature ONE_ARGUMENT

ONE_OPT_ARGUMENT	back to summary
public static final Signature ONE_OPT_ARGUMENT

ONE_REQUIRED	back to summary
public static final Signature ONE_REQUIRED

opt	back to summary
private final short opt

OPTIONAL	back to summary
public static final Signature OPTIONAL

post	back to summary
private final short post

pre	back to summary
private final short pre

requiredKwargs	back to summary
private final short requiredKwargs

rest	back to summary
private final Signature.Rest rest

THREE_ARGUMENTS	back to summary
public static final Signature THREE_ARGUMENTS

THREE_REQUIRED	back to summary
public static final Signature THREE_REQUIRED

TWO_ARGUMENTS	back to summary
public static final Signature TWO_ARGUMENTS

TWO_REQUIRED	back to summary
public static final Signature TWO_REQUIRED

Constructor Detail

Signature	back to summary
public Signature(int pre, int opt, int post, Signature.Rest rest, int kwargs, int requiredKwargs, int keyRest)

Method Detail

arity	back to summary
public Arity arity() Deprecated Annotations @Deprecated

arityValue	back to summary
public int arityValue()

calculateArityValue	back to summary
public int calculateArityValue() 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.

calculateArityValue

back to summary

public int calculateArityValue()

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.

checkArity	back to summary
public void checkArity(Ruby runtime, IRubyObject[] args) Deprecated since 10.0. Annotations @Deprecated since:10.0

checkArity	back to summary
public void checkArity(ThreadContext context, IRubyObject[] args)

decode	back to summary
public static Signature decode(long l)

encode	back to summary
public long encode()

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

from	back to summary
public static Signature from(Arity arity) Deprecated Annotations @Deprecated

from	back to summary
public static Signature from(int pre, int opt, int post, int kwargs, int requiredKwargs, Signature.Rest rest, int keyRest)

from	back to summary
public static Signature from(ArgsNode args)

from	back to summary
public static Signature from(IterNode iter)

from	back to summary
public static Signature from(ForNode iter)

from	back to summary
public static Signature from(PreExeNode iter)

from	back to summary
public static Signature from(PostExeNode iter)

fromArityValue	back to summary
public static Signature fromArityValue(int arityValue)

getRequiredKeywordForArityCount	back to summary
public int getRequiredKeywordForArityCount()

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

hasKwargs	back to summary
public boolean hasKwargs()

hasRest	back to summary
public boolean hasRest()

isFixed	back to summary
public boolean isFixed() Are there an exact (fixed) number of parameters to this signature?

isNoArguments	back to summary
public boolean isNoArguments() Is this a signature with a no arguments of any kind?

isOneArgument	back to summary
public boolean isOneArgument() Is this a signature with a single fixed argument and NO keyword arguments?

isSpreadable

back to summary

public boolean isSpreadable()

If we are yield'ing to this signature should we spread/destructure a Ruby Array?

Returns:boolean: true if the signature expects multiple args

isTwoArguments	back to summary
public boolean isTwoArguments() Is this a signature with a two fixed arguments and NO keyword arguments?

keyRest	back to summary
public int keyRest()

kwargs

back to summary

public int kwargs()

Total number of keyword argument parameters.

Returns:int: the number of kwarg parameters

max

back to summary

public int max()

The maximum number of parameters supplied which can fulfill a call to this signature. This method is for calculating the public-facing arity value.

Returns:int: the minimum amount of params expected.

min

back to summary

public int min()

The minimum number of parameters supplied which can fulfill a call to this signature. This method is for calculating the public-facing arity value.

Returns:int: the minimum amount of params expected.

opt	back to summary
public int opt()

post	back to summary
public int post()

pre	back to summary
public int pre()

required	back to summary
public int required()

rest	back to summary
public Signature.Rest rest()

restFromArg	back to summary
private static Signature.Rest restFromArg(Node restArg)

restKwargs	back to summary
public boolean restKwargs()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

Modifier and Type	Field and Description
public static final Signature.Rest	ANON
public static final Signature.Rest	NONE
public static final Signature.Rest	NORM
public static final Signature.Rest	STAR
private static final Signature.Rest[]	VALUES

Modifier and Type	Method and Description
public static Signature.Rest	fromOrdinal(int ordinal)
public static Signature.Rest	valueOf(String name)
public static Signature.Rest[]	values()

public Class Signature

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Signature.Rest

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail