com.oracle.truffle.api.interop

Class ArityException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.oracle.truffle.api.interop.InteropException

com.oracle.truffle.api.interop.ArityException

All Implemented Interfaces:

Serializable

public final class ArityException
extends InteropException

An exception thrown if a executable or instantiable object was provided with the wrong number of arguments.

Since:

0.11

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static ArityException	create(int expectedArity, int actualArity) Creates an ArityException to indicate that the wrong number of arguments were provided.
static ArityException	create(int expectedArity, int actualArity, Throwable cause) Creates an ArityException to indicate that the wrong number of arguments were provided.
int	getActualArity() Returns the actual number of arguments provided by the foreign access.
int	getExpectedArity() Returns the number of arguments that the foreign object expects.
String	getMessage()

Methods inherited from class com.oracle.truffle.api.interop.InteropException

fillInStackTrace, getCause

Methods inherited from class java.lang.Throwable

addSuppressed, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

Since:

19.0

getExpectedArity

public int getExpectedArity()

Returns the number of arguments that the foreign object expects.

Returns:

the number of expected arguments

Since:

0.11

getActualArity

public int getActualArity()

Returns the actual number of arguments provided by the foreign access.

Returns:

the number of provided arguments

Since:

0.11

create

public static ArityException create(int expectedArity,
                                    int actualArity)

Creates an ArityException to indicate that the wrong number of arguments were provided.

This method is designed to be used in compiled code paths.

Parameters:

expectedArity - the number of arguments expected by the foreign object

actualArity - the number of provided by the foreign access

Since:

19.0

create

public static ArityException create(int expectedArity,
                                    int actualArity,
                                    Throwable cause)

Creates an ArityException to indicate that the wrong number of arguments were provided.

In addition a cause may be provided. The cause should only be set if the guest language code caused this problem. An example for this is a language specific proxy mechanism that invokes guest language code to describe an object. If the guest language code fails to execute and this interop exception is a valid interpretation of the error, then the error should be provided as cause. The cause can then be used by the source language as new exception cause if the InteropException is translated to a source language error. If the InteropException is discarded, then the cause will most likely get discarded by the source language as well. Note that the cause must be of type TruffleException in addition to Throwable otherwise an IllegalArgumentException is thrown.

This method is designed to be used in compiled code paths.

Parameters:

expectedArity - the number of arguments expected by the foreign object

actualArity - the number of provided by the foreign access

cause - the guest language exception that caused the error.

Since:

20.2