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

Modifier and Type	Field and Description
private static final Map<Integer, Arity>	arities
public static final Arity	NO_ARGUMENTS
public static final Arity	ONE_ARGUMENT
public static final Arity	ONE_REQUIRED
public static final Arity	OPTIONAL
private static final long	serialVersionUID
public static final Arity	THREE_ARGUMENTS
public static final Arity	THREE_REQUIRED
public static final Arity	TWO_ARGUMENTS
public static final Arity	TWO_REQUIRED
public static final int	UNLIMITED_ARGUMENTS
private final int	value

Access	Constructor and Description
private	Arity(int value)

Method Summary

Modifier and Type	Method and Description
public static int	checkArgumentCount(ThreadContext context, IRubyObject[] args, int min, int max)
public static int	checkArgumentCount(ThreadContext context, String name, IRubyObject[] args, int min, int max)
public static int	checkArgumentCount(ThreadContext context, int length, int min, int max)
public static int	checkArgumentCount(ThreadContext context, int length, int min, int max, boolean hasKwargs)
public static int	checkArgumentCount(ThreadContext context, String name, int length, int min, int max)
public static int	checkArgumentCount(Ruby runtime, String name, int length, int min, int max, boolean hasKwargs)
public static int	checkArgumentCount(Ruby runtime, IRubyObject[] args, int min, int max) Deprecated
public static int	checkArgumentCount(Ruby runtime, String name, IRubyObject[] args, int min, int max) Deprecated
public static int	checkArgumentCount(Ruby runtime, int length, int min, int max) Deprecated
public static int	checkArgumentCount(Ruby runtime, int length, int min, int max, boolean hasKwargs) Deprecated
public static int	checkArgumentCount(Ruby runtime, String name, int length, int min, int max) Deprecated
public void	checkArity(Ruby runtime, IRubyObject[] args)
public void	checkArity(Ruby runtime, int length)
private static Arity	createArity(int required, int optional, boolean rest)
public static Arity	createArity(int value)
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 Arity	fixed(int arity)
public static Arity	fromAnnotation(JRubyMethod anno)
public static Arity	fromAnnotation(JRubyMethod anno, int required)
public static Arity	fromAnnotation(JRubyMethod anno, Class<T>[] parameterTypes, boolean isStatic)
public int	getValue()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isFixed()
private static Arity	newArity(int value)
public static Arity	noArguments()
public static Arity	optional()
public static void	raiseArgumentError(ThreadContext context, int length, int min, int max)
public static void	raiseArgumentError(ThreadContext context, IRubyObject[] args, int min, int max)
public static void	raiseArgumentError(ThreadContext context, int length, int min, int max, boolean hasKwargs)
public static void	raiseArgumentError(ThreadContext context, String name, int length, int min, int max)
public static void	raiseArgumentError(Ruby runtime, String name, int length, int min, int max, boolean hasKwargs)
public static void	raiseArgumentError(Ruby runtime, IRubyObject[] args, int min, int max) Deprecated
public static void	raiseArgumentError(Ruby runtime, int length, int min, int max) Deprecated
public static void	raiseArgumentError(Ruby runtime, int length, int min, int max, boolean hasKwargs) Deprecated
public static void	raiseArgumentError(Ruby runtime, String name, int length, int min, int max) Deprecated
public static Arity	required(int minimum)
public int	required()
public static IRubyObject[]	scanArgs(Ruby runtime, IRubyObject[] args, int required, int optional) Deprecated since 10.0.
public static IRubyObject[]	scanArgs(ThreadContext context, IRubyObject[] args, int required, int optional)
public static Arity	singleArgument()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static Arity	twoArguments()

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

arities	back to summary
private static final Map<Integer, Arity> arities

NO_ARGUMENTS	back to summary
public static final Arity NO_ARGUMENTS

ONE_ARGUMENT	back to summary
public static final Arity ONE_ARGUMENT

ONE_REQUIRED	back to summary
public static final Arity ONE_REQUIRED

OPTIONAL	back to summary
public static final Arity OPTIONAL

serialVersionUID	back to summary
private static final long serialVersionUID

THREE_ARGUMENTS	back to summary
public static final Arity THREE_ARGUMENTS

THREE_REQUIRED	back to summary
public static final Arity THREE_REQUIRED

TWO_ARGUMENTS	back to summary
public static final Arity TWO_ARGUMENTS

TWO_REQUIRED	back to summary
public static final Arity TWO_REQUIRED

UNLIMITED_ARGUMENTS	back to summary
public static final int UNLIMITED_ARGUMENTS

value	back to summary
private final int value

Arity	back to summary
private Arity(int value)

Method Detail

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

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

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

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

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

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

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

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

checkArgumentCount	back to summary
public static int checkArgumentCount(Ruby runtime, int length, int min, int max) Deprecated Annotations @Deprecated

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

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

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

checkArity	back to summary
public void checkArity(Ruby runtime, int length)

createArity	back to summary
private static Arity createArity(int required, int optional, boolean rest)

createArity	back to summary
public static Arity createArity(int value)

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

fixed	back to summary
public static Arity fixed(int arity)

fromAnnotation	back to summary
public static Arity fromAnnotation(JRubyMethod anno)

fromAnnotation	back to summary
public static Arity fromAnnotation(JRubyMethod anno, int required)

fromAnnotation	back to summary
public static Arity fromAnnotation(JRubyMethod anno, Class<T>[] parameterTypes, boolean isStatic)

getValue	back to summary
public int getValue()

hashCode back to summary

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

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

isFixed	back to summary
public boolean isFixed()

newArity	back to summary
private static Arity newArity(int value)

noArguments	back to summary
public static Arity noArguments()

optional	back to summary
public static Arity optional()

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

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

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

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

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

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

raiseArgumentError	back to summary
public static void raiseArgumentError(Ruby runtime, int length, int min, int max) Deprecated Annotations @Deprecated

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

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

required	back to summary
public static Arity required(int minimum)

required	back to summary
public int required()

scanArgs	back to summary
public static IRubyObject[] scanArgs(Ruby runtime, IRubyObject[] args, int required, int optional) Deprecated since 10.0. Annotations @Deprecated since:10.0

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

singleArgument	back to summary
public static Arity singleArgument()

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

Annotations

@Override

twoArguments	back to summary
public static Arity twoArguments()

public final Class Arity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail