InteropLibrary

java.lang.Object
- com.oracle.truffle.api.nodes.Node
- - com.oracle.truffle.api.library.Library
  - - com.oracle.truffle.api.interop.InteropLibrary

All Implemented Interfaces:

NodeInterface, Cloneable
```
public abstract class InteropLibrary
extends Library
```
Represents the library that specifies the interoperability message protocol between Truffle languages, tools and embedders. Every method represents one message specified by the protocol. In the following text we will abbreviate interoperability with interop.
The interop API differentiates between the source and the target language. The source language is the language that implements/exports the message implementations. The implementations map types of the source language to the interop protocol as it is specified by the protocol. For example, language values that represent arrays or array like structures should implement the messages for array based access. This allows the target language to call the protocol without knowledge of the concrete source language. The target language embeds the interop protocol semantics as part of their existing language semantics. For example, language operations that access array elements in the target language should call array access messages for interop values.
The interop protocol only allows interop values to be used as receivers, return values or parameters of messages. Allowed Java types of interop values are:
- TruffleObject: Any subclass of TruffleObject is interpreted depending on the interop messages it exports. Truffle objects are expected but not required to export interop library messages.
- String and Character are interpreted as string value.
- Boolean is interpreted as boolean value.
- Byte, Short, Integer, Long, Float and Double are interpreted as number values.
The following type combinations are mutually exclusive and cannot return true for the type check message of the same receiver value:
All receiver values may be executable, instantiable, pointers, have members or array elements at the same time.

Naive and aware dates and times

If a date or time value has a timezone then it is called aware , otherwise naive
An aware time and date has sufficient knowledge of applicable algorithmic and political time adjustments, such as time zone and daylight saving time information, to locate itself relative to other aware objects. An aware object is used to represent a specific moment in time that is not open to interpretation.
A naive time and date does not contain enough information to unambiguously locate itself relative to other date/time objects. Whether a naive object represents Coordinated Universal Time (UTC), local time, or time in some other timezone is purely up to the program, just like it is up to the program whether a particular number represents metres, miles, or mass. Naive objects are easy to understand and to work with, at the cost of ignoring some aspects of reality.
Interop messages throw checked exceptions to indicate error states. The target language is supposed to always catch those exceptions and translate them into guest language errors of the target language. Interop message contracts are verified only if assertions (-ea) are enabled.
Since:

19.0

See Also:

Reference documentation of Truffle Libraries.

Nested Class Summary
- Nested classes/interfaces inherited from class com.oracle.truffle.api.nodes.Node
  Node.Child, Node.Children

Constructor Summary

Constructors
Modifier Constructor and Description

protected InteropLibrary()

Constructors
Modifier	Constructor and Description
`protected`	`InteropLibrary()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`asBoolean(Object receiver)` Returns the Java boolean value if the receiver represents a `boolean` like value.
`byte`	`asByte(Object receiver)` Returns the receiver value as Java byte primitive if the number fits without loss of precision.
`LocalDate`	`asDate(Object receiver)` Returns the receiver as date if this object represents a `date`.
`double`	`asDouble(Object receiver)` Returns the receiver value as Java double primitive if the number fits without loss of precision.
`Duration`	`asDuration(Object receiver)` Returns the receiver as duration if this object represents a `duration`.
`float`	`asFloat(Object receiver)` Returns the receiver value as Java float primitive if the number fits without loss of precision.
`Instant`	`asInstant(Object receiver)` Returns the receiver as instant if this object represents an `instant`.
`int`	`asInt(Object receiver)` Returns the receiver value as Java int primitive if the number fits without loss of precision.
`long`	`asLong(Object receiver)` Returns the receiver value as Java long primitive if the number fits without loss of precision.
`long`	`asPointer(Object receiver)` Returns the pointer value as long value if the receiver represents a pointer like value.
`protected boolean`	`assertAdopted()` Utility for libraries to require adoption before cached versions of nodes can be executed.
`short`	`asShort(Object receiver)` Returns the receiver value as Java short primitive if the number fits without loss of precision.
`String`	`asString(Object receiver)` Returns the Java boolean value if the receiver represents a `boolean` like value.
`LocalTime`	`asTime(Object receiver)` Returns the receiver as time if this object represents a `time`.
`ZoneId`	`asTimeZone(Object receiver)` Returns the receiver as timestamp if this object represents a `timezone`.
`Object`	`execute(Object receiver, Object... arguments)` Executes an executable value with the given arguments.
`boolean`	`fitsInByte(Object receiver)` Returns `true` if the receiver represents a `number` and its value fits in a Java byte primitive without loss of precision, else `false`.
`boolean`	`fitsInDouble(Object receiver)` Returns `true` if the receiver represents a `number` and its value fits in a Java double primitive without loss of precision, else `false`.
`boolean`	`fitsInFloat(Object receiver)` Returns `true` if the receiver represents a `number` and its value fits in a Java float primitive without loss of precision, else `false`.
`boolean`	`fitsInInt(Object receiver)` Returns `true` if the receiver represents a `number` and its value fits in a Java int primitive without loss of precision, else `false`.
`boolean`	`fitsInLong(Object receiver)` Returns `true` if the receiver represents a `number` and its value fits in a Java long primitive without loss of precision, else `false`.
`boolean`	`fitsInShort(Object receiver)` Returns `true` if the receiver represents a `number` and its value fits in a Java short primitive without loss of precision, else `false`.
`long`	`getArraySize(Object receiver)` Returns the array size of the receiver.
`static LibraryFactory<InteropLibrary>`	`getFactory()` Returns the library factory for the interop library.
`Object`	`getMembers(Object receiver)` Short-cut for `getMembers(receiver, false)`.
`Object`	`getMembers(Object receiver, boolean includeInternal)` Returns an array of member name strings.
`boolean`	`hasArrayElements(Object receiver)` Returns `true` if the receiver may have array elements.
`boolean`	`hasMemberReadSideEffects(Object receiver, String member)` Returns `true` if reading a member may cause a side-effect.
`boolean`	`hasMembers(Object receiver)` Returns `true` if the receiver may have members.
`boolean`	`hasMemberWriteSideEffects(Object receiver, String member)` Returns `true` if writing a member may cause a side-effect, besides the write operation of the member.
`Object`	`instantiate(Object receiver, Object... arguments)` Instantiates the receiver value with the given arguments.
`Object`	`invokeMember(Object receiver, String member, Object... arguments)` Invokes a member for a given receiver and arguments.
`boolean`	`isArrayElementExisting(Object receiver, long index)` Returns true if the array element is existing.
`boolean`	`isArrayElementInsertable(Object receiver, long index)` Returns `true` if a given array element index is not existing and `insertable`.
`boolean`	`isArrayElementModifiable(Object receiver, long index)` Returns `true` if a given array element index is existing and `writable`.
`boolean`	`isArrayElementReadable(Object receiver, long index)` Returns `true` if a given array element is `readable`.
`boolean`	`isArrayElementRemovable(Object receiver, long index)` Returns `true` if a given array element index is existing and `removable`.
`boolean`	`isArrayElementWritable(Object receiver, long index)` Returns true if the array element is `modifiable` or `insertable`.
`boolean`	`isBoolean(Object receiver)` Returns `true` if the receiver represents a `boolean` like value, else `false`.
`boolean`	`isDate(Object receiver)` Returns `true` if this object represents a date, else `false`.
`boolean`	`isDuration(Object receiver)` Returns `true` if this object represents a duration, else `false`.
`boolean`	`isExecutable(Object receiver)` Returns `true` if the receiver represents an `executable` value, else `false`.
`boolean`	`isInstant(Object receiver)` Returns `true` if the receiver represents an instant.
`boolean`	`isInstantiable(Object receiver)` Returns `true` if the receiver represents an `instantiable` value, else `false`.
`boolean`	`isMemberExisting(Object receiver, String member)` Returns true if the member is existing.
`boolean`	`isMemberInsertable(Object receiver, String member)` Returns `true` if a given member is not existing and `writable`.
`boolean`	`isMemberInternal(Object receiver, String member)` Returns true if a member is internal.
`boolean`	`isMemberInvocable(Object receiver, String member)` Returns `true` if a given member is invocable.
`boolean`	`isMemberModifiable(Object receiver, String member)` Returns `true` if a given member is existing and `writable`.
`boolean`	`isMemberReadable(Object receiver, String member)` Returns `true` if a given member is `readable`.
`boolean`	`isMemberRemovable(Object receiver, String member)` Returns `true` if a given member is existing and removable.
`boolean`	`isMemberWritable(Object receiver, String member)` Returns true if the member is `modifiable` or `insertable`.
`boolean`	`isNull(Object receiver)` Returns `true` if the receiver represents a `null` like value, else `false`.
`boolean`	`isNumber(Object receiver)` Returns `true` if the receiver represents a `number` value, else `false`.
`boolean`	`isPointer(Object receiver)` Returns `true` if the receiver value represents a native pointer.
`boolean`	`isString(Object receiver)` Returns `true` if the receiver represents a `string` value, else `false`.
`boolean`	`isTime(Object receiver)` Returns `true` if this object represents a time, else `false`.
`boolean`	`isTimeZone(Object receiver)` Returns `true` if this object represents a timezone, else `false`.
`Object`	`readArrayElement(Object receiver, long index)` Reads the value of an array element by index.
`Object`	`readMember(Object receiver, String member)` Reads the value of a given member.
`void`	`removeArrayElement(Object receiver, long index)` Remove an array element from the receiver object.
`void`	`removeMember(Object receiver, String member)` Removes a member from the receiver object.
`void`	`toNative(Object receiver)` Transforms a `receiver` to a value that represents a raw native pointer.
`void`	`writeArrayElement(Object receiver, long index, Object value)` Writes the value of an array element by index.
`void`	`writeMember(Object receiver, String member, Object value)` Writes the value of a given member.

Methods inherited from class com.oracle.truffle.api.library.Library
accepts

Methods inherited from class com.oracle.truffle.api.nodes.Node
accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, getCost, getDebugProperties, getDescription, getEncapsulatingSourceSection, getLock, getParent, getRootNode, getSourceSection, insert, insert, isAdoptable, isSafelyReplaceableBy, lookupContextReference, lookupLanguageReference, notifyInserted, onReplace, replace, replace, reportPolymorphicSpecialize, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InteropLibrary
```
protected InteropLibrary()
```
    Since:
    
    19.0
- Method Detail
  - isNull
```
public boolean isNull(Object receiver)
```
    Returns true if the receiver represents a null like value, else false. Most object oriented languages have one or many values representing null values. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
  - isBoolean
```
public boolean isBoolean(Object receiver)
```
    Returns true if the receiver represents a boolean like value, else false. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.asBoolean(Object)
  - asBoolean
```
public boolean asBoolean(Object receiver)
                  throws UnsupportedMessageException
```
    Returns the Java boolean value if the receiver represents a boolean like value.
    
    Throws:
    
    UnsupportedMessageException - if and only if InteropLibrary.isBoolean(Object) returns false for the same receiver.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isBoolean(Object)
  - isExecutable
```
public boolean isExecutable(Object receiver)
```
    Returns true if the receiver represents an executable value, else false. Functions, methods or closures are common examples of executable values. Invoking this message does not cause any observable side-effects. Note that receiver values which are executable might also be instantiable.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.execute(Object, Object...)
  - execute
```
public Object execute(Object receiver,
                      Object... arguments)
               throws UnsupportedTypeException,
                      ArityException,
                      UnsupportedMessageException
```
    Executes an executable value with the given arguments.
    
    Throws:
    
    UnsupportedTypeException - if one of the arguments is not compatible to the executable signature
    
    ArityException - if the number of expected arguments does not match the number of actual arguments.
    
    UnsupportedMessageException - if and only if InteropLibrary.isExecutable(Object) returns false for the same receiver.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isExecutable(Object)
  - isInstantiable
```
public boolean isInstantiable(Object receiver)
```
    Returns true if the receiver represents an instantiable value, else false. Contructors or meta-objects are typical examples of instantiable values. Invoking this message does not cause any observable side-effects. Note that receiver values which are executable might also be instantiable.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.instantiate(Object, Object...)
  - instantiate
```
public Object instantiate(Object receiver,
                          Object... arguments)
                   throws UnsupportedTypeException,
                          ArityException,
                          UnsupportedMessageException
```
    Instantiates the receiver value with the given arguments.
    
    Throws:
    
    UnsupportedTypeException - if one of the arguments is not compatible to the executable signature
    
    ArityException - if the number of expected arguments does not match the number of actual arguments.
    
    UnsupportedMessageException - if and only if InteropLibrary.isInstantiable(Object) returns false for the same receiver.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isExecutable(Object)
  - isString
```
public boolean isString(Object receiver)
```
    Returns true if the receiver represents a string value, else false. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.asString(Object)
  - asString
```
public String asString(Object receiver)
                throws UnsupportedMessageException
```
    Returns the Java boolean value if the receiver represents a boolean like value.
    
    Throws:
    
    UnsupportedMessageException - if and only if InteropLibrary.isString(Object) returns false for the same receiver.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isBoolean(Object)
  - isNumber
```
public boolean isNumber(Object receiver)
```
    Returns true if the receiver represents a number value, else false. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.fitsInByte(Object), InteropLibrary.fitsInShort(Object), InteropLibrary.fitsInInt(Object), InteropLibrary.fitsInLong(Object), InteropLibrary.fitsInFloat(Object), InteropLibrary.fitsInDouble(Object), InteropLibrary.asByte(Object), InteropLibrary.asShort(Object), InteropLibrary.asInt(Object), InteropLibrary.asLong(Object), InteropLibrary.asFloat(Object), InteropLibrary.asDouble(Object)
  - fitsInByte
```
public boolean fitsInByte(Object receiver)
```
    Returns true if the receiver represents a number and its value fits in a Java byte primitive without loss of precision, else false. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.asByte(Object)
  - fitsInShort
```
public boolean fitsInShort(Object receiver)
```
    Returns true if the receiver represents a number and its value fits in a Java short primitive without loss of precision, else false. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.asShort(Object)
  - fitsInInt
```
public boolean fitsInInt(Object receiver)
```
    Returns true if the receiver represents a number and its value fits in a Java int primitive without loss of precision, else false. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.asInt(Object)
  - fitsInLong
```
public boolean fitsInLong(Object receiver)
```
    Returns true if the receiver represents a number and its value fits in a Java long primitive without loss of precision, else false. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.asLong(Object)
  - fitsInFloat
```
public boolean fitsInFloat(Object receiver)
```
    Returns true if the receiver represents a number and its value fits in a Java float primitive without loss of precision, else false. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.asFloat(Object)
  - fitsInDouble
```
public boolean fitsInDouble(Object receiver)
```
    Returns true if the receiver represents a number and its value fits in a Java double primitive without loss of precision, else false. Invoking this message does not cause any observable side-effects.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.asDouble(Object)
  - asByte
```
public byte asByte(Object receiver)
            throws UnsupportedMessageException
```
    Returns the receiver value as Java byte primitive if the number fits without loss of precision. Invoking this message does not cause any observable side-effects.
    
    Throws:
    
    UnsupportedMessageException - if and only if the receiver is not a InteropLibrary.isNumber(Object) or it does not fit without less of precision.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.fitsInByte(Object)
  - asShort
```
public short asShort(Object receiver)
              throws UnsupportedMessageException
```
    Returns the receiver value as Java short primitive if the number fits without loss of precision. Invoking this message does not cause any observable side-effects.
    
    Throws:
    
    UnsupportedMessageException - if and only if the receiver is not a InteropLibrary.isNumber(Object) or it does not fit without less of precision.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.fitsInShort(Object)
  - asInt
```
public int asInt(Object receiver)
          throws UnsupportedMessageException
```
    Returns the receiver value as Java int primitive if the number fits without loss of precision. Invoking this message does not cause any observable side-effects.
    
    Throws:
    
    UnsupportedMessageException - if and only if the receiver is not a InteropLibrary.isNumber(Object) or it does not fit without less of precision.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.fitsInInt(Object)
  - asLong
```
public long asLong(Object receiver)
            throws UnsupportedMessageException
```
    Returns the receiver value as Java long primitive if the number fits without loss of precision. Invoking this message does not cause any observable side-effects.
    
    Throws:
    
    UnsupportedMessageException - if and only if the receiver is not a InteropLibrary.isNumber(Object) or it does not fit without less of precision.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.fitsInLong(Object)
  - asFloat
```
public float asFloat(Object receiver)
              throws UnsupportedMessageException
```
    Returns the receiver value as Java float primitive if the number fits without loss of precision. Invoking this message does not cause any observable side-effects.
    
    Throws:
    
    UnsupportedMessageException - if and only if the receiver is not a InteropLibrary.isNumber(Object) or it does not fit without less of precision.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.fitsInFloat(Object)
  - asDouble
```
public double asDouble(Object receiver)
                throws UnsupportedMessageException
```
    Returns the receiver value as Java double primitive if the number fits without loss of precision. Invoking this message does not cause any observable side-effects.
    
    Throws:
    
    UnsupportedMessageException - if and only if the receiver is not a InteropLibrary.isNumber(Object) or it does not fit without less of precision.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isNumber(Object), InteropLibrary.fitsInDouble(Object)
  - hasMembers
```
public boolean hasMembers(Object receiver)
```
    Returns true if the receiver may have members. Members are structural elements of a class. For example, a method or field is a member of a class. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.getMembers(Object, boolean), InteropLibrary.isMemberReadable(Object, String), InteropLibrary.isMemberModifiable(Object, String), InteropLibrary.isMemberInvocable(Object, String), InteropLibrary.isMemberInsertable(Object, String), InteropLibrary.isMemberRemovable(Object, String), InteropLibrary.readMember(Object, String), InteropLibrary.writeMember(Object, String, Object), InteropLibrary.removeMember(Object, String), InteropLibrary.invokeMember(Object, String, Object...)
  - getMembers
```
public Object getMembers(Object receiver,
                         boolean includeInternal)
                  throws UnsupportedMessageException
```
    Returns an array of member name strings. The returned value must return true for InteropLibrary.hasArrayElements(Object) and every array element must be of type string.
    If the includeInternal argument is true then internal member names are returned as well. Internal members are implementation specific and should not be exposed to guest language application. An example of internal members are internal slots in ECMAScript.
    
    Throws:
    
    UnsupportedMessageException - if and only if the receiver does not have any members.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.hasMembers(Object)
  - getMembers
```
public final Object getMembers(Object receiver)
                        throws UnsupportedMessageException
```
    Short-cut for getMembers(receiver, false). Invoking this message does not cause any observable side-effects.
    
    Throws:
    
    UnsupportedMessageException - if and only if the receiver has no members.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.getMembers(Object, boolean)
  - isMemberReadable
```
public boolean isMemberReadable(Object receiver,
                                String member)
```
    Returns true if a given member is readable. This method may only return true if InteropLibrary.hasMembers(Object) returns true as well and InteropLibrary.isMemberInsertable(Object, String) returns false. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.readMember(Object, String)
  - readMember
```
public Object readMember(Object receiver,
                         String member)
                  throws UnsupportedMessageException,
                         UnknownIdentifierException
```
    Reads the value of a given member. If the member is readable and invocable then the result of reading the member is executable and is bound to this receiver. This method must have not observable side-effects unless InteropLibrary.hasMemberReadSideEffects(Object, String) returns true.
    
    Throws:
    
    UnsupportedMessageException - if the member is not readable
    
    UnknownIdentifierException - if the given member does not exist.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.hasMemberReadSideEffects(Object, String)
  - isMemberModifiable
```
public boolean isMemberModifiable(Object receiver,
                                  String member)
```
    Returns true if a given member is existing and writable. This method may only return true if InteropLibrary.hasMembers(Object) returns true as well and InteropLibrary.isMemberInsertable(Object, String) returns false. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.writeMember(Object, String, Object)
  - isMemberInsertable
```
public boolean isMemberInsertable(Object receiver,
                                  String member)
```
    Returns true if a given member is not existing and writable. This method may only return true if InteropLibrary.hasMembers(Object) returns true as well and InteropLibrary.isMemberExisting(Object, String) returns false. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.writeMember(Object, String, Object)
  - writeMember
```
public void writeMember(Object receiver,
                        String member,
                        Object value)
                 throws UnsupportedMessageException,
                        UnknownIdentifierException,
                        UnsupportedTypeException
```
    Writes the value of a given member. Writing a member is allowed if is existing and modifiable, or not existing and insertable. This method must have not observable side-effects other than the changed member unless side-effects are allowed.
    
    Throws:
    
    UnsupportedMessageException - if the member is not writable
    
    UnknownIdentifierException - if the given member is not insertable and does not exist.
    
    UnsupportedTypeException - if the provided value type is not allowed to be written
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.hasMemberWriteSideEffects(Object, String)
  - isMemberRemovable
```
public boolean isMemberRemovable(Object receiver,
                                 String member)
```
    Returns true if a given member is existing and removable. This method may only return true if InteropLibrary.hasMembers(Object) returns true as well and InteropLibrary.isMemberInsertable(Object, String) returns false. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.removeMember(Object, String)
  - removeMember
```
public void removeMember(Object receiver,
                         String member)
                  throws UnsupportedMessageException,
                         UnknownIdentifierException
```
    Removes a member from the receiver object. Removing member is allowed if is removable. This method does not have not observable side-effects other than the removed member.
    
    Throws:
    
    UnsupportedMessageException - if the member is not removable
    
    UnknownIdentifierException - if the given member is not existing but removing would be allowed
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isMemberRemovable(Object, String)
  - isMemberInvocable
```
public boolean isMemberInvocable(Object receiver,
                                 String member)
```
    Returns true if a given member is invocable. This method may only return true if InteropLibrary.hasMembers(Object) returns true as well and InteropLibrary.isMemberInsertable(Object, String) returns false. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.invokeMember(Object, String, Object...)
  - invokeMember
```
public Object invokeMember(Object receiver,
                           String member,
                           Object... arguments)
                    throws UnsupportedMessageException,
                           ArityException,
                           UnknownIdentifierException,
                           UnsupportedTypeException
```
    Invokes a member for a given receiver and arguments.
    
    Throws:
    
    UnknownIdentifierException - if the given member does not exist.
    
    UnsupportedTypeException - if one of the arguments is not compatible to the executable signature
    
    ArityException - if the number of expected arguments does not match the number of actual arguments.
    
    UnsupportedMessageException - if the member is not invocable
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isMemberInvocable(Object, String)
  - isMemberInternal
```
public boolean isMemberInternal(Object receiver,
                                String member)
```
    Returns true if a member is internal. Internal members are not enumerated by InteropLibrary.getMembers(Object, boolean) by default. Internal members are only relevant to guest language implementations and tools, but not to guest applications or embedders. An example of internal members are internal slots in ECMAScript. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.getMembers(Object, boolean)
  - isMemberWritable
```
public final boolean isMemberWritable(Object receiver,
                                      String member)
```
    Returns true if the member is modifiable or insertable.
    
    Since:
    
    19.0
  - isMemberExisting
```
public final boolean isMemberExisting(Object receiver,
                                      String member)
```
    Returns true if the member is existing. A member is existing if it is modifiable, readable, removable or invocable.
    
    Since:
    
    19.0
  - hasMemberReadSideEffects
```
public boolean hasMemberReadSideEffects(Object receiver,
                                        String member)
```
    Returns true if reading a member may cause a side-effect. Invoking this message does not cause any observable side-effects. A member read does not cause any side-effects by default.
    For instance in JavaScript a property read may have side-effects if the property has a getter function.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.readMember(Object, String)
  - hasMemberWriteSideEffects
```
public boolean hasMemberWriteSideEffects(Object receiver,
                                         String member)
```
    Returns true if writing a member may cause a side-effect, besides the write operation of the member. Invoking this message does not cause any observable side-effects. A member write does not cause any side-effects by default.
    For instance in JavaScript a property write may have side-effects if the property has a setter function.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.writeMember(Object, String, Object)
  - hasArrayElements
```
public boolean hasArrayElements(Object receiver)
```
    Returns true if the receiver may have array elements. For example, the contents of an array or list datastructure could be interpreted as array elements. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.getArraySize(Object)
  - readArrayElement
```
public Object readArrayElement(Object receiver,
                               long index)
                        throws UnsupportedMessageException,
                               InvalidArrayIndexException
```
    Reads the value of an array element by index. This method must have not observable side-effect.
    
    Throws:
    
    UnsupportedMessageException - if the array element is not readable.
    
    InvalidArrayIndexException - if the array index is out of bounds or invalid.
    
    Since:
    
    19.0
  - getArraySize
```
public long getArraySize(Object receiver)
                  throws UnsupportedMessageException
```
    Returns the array size of the receiver.
    
    Throws:
    
    UnsupportedMessageException - if and only if InteropLibrary.hasArrayElements(Object) returns false.
    
    Since:
    
    19.0
  - isArrayElementReadable
```
public boolean isArrayElementReadable(Object receiver,
                                      long index)
```
    Returns true if a given array element is readable. This method may only return true if InteropLibrary.hasArrayElements(Object) returns true as well. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.readArrayElement(Object, long)
  - writeArrayElement
```
public void writeArrayElement(Object receiver,
                              long index,
                              Object value)
                       throws UnsupportedMessageException,
                              UnsupportedTypeException,
                              InvalidArrayIndexException
```
    Writes the value of an array element by index. Writing an array element is allowed if is existing and modifiable, or not existing and insertable. This method must have not observable side-effects other than the changed array element.
    
    Throws:
    
    UnsupportedMessageException - if the array element is not writable
    
    InvalidArrayIndexException - if the array element is not insertable and does not exist.
    
    UnsupportedTypeException - if the provided value type is not allowed to be written
    
    Since:
    
    19.0
  - removeArrayElement
```
public void removeArrayElement(Object receiver,
                               long index)
                        throws UnsupportedMessageException,
                               InvalidArrayIndexException
```
    Remove an array element from the receiver object. Removing member is allowed if the array element is removable. This method may only return true if InteropLibrary.hasArrayElements(Object) returns true as well and InteropLibrary.isArrayElementInsertable(Object, long) returns false. This method does not have not observable side-effects other than the removed array element.
    
    Throws:
    
    UnsupportedMessageException - if the array element is not removable
    
    InvalidArrayIndexException - if the given array element index is not existing but removing would be allowed
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isArrayElementRemovable(Object, long)
  - isArrayElementModifiable
```
public boolean isArrayElementModifiable(Object receiver,
                                        long index)
```
    Returns true if a given array element index is existing and writable. This method may only return true if InteropLibrary.hasArrayElements(Object) returns true as well and InteropLibrary.isArrayElementInsertable(Object, long) returns false. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.writeArrayElement(Object, long, Object), InteropLibrary.isArrayElementInsertable(Object, long)
  - isArrayElementInsertable
```
public boolean isArrayElementInsertable(Object receiver,
                                        long index)
```
    Returns true if a given array element index is not existing and insertable. This method may only return true if InteropLibrary.hasArrayElements(Object) returns true as well and InteropLibrary.isArrayElementExisting(Object, long)} returns false. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.writeArrayElement(Object, long, Object), InteropLibrary.isArrayElementModifiable(Object, long)
  - isArrayElementRemovable
```
public boolean isArrayElementRemovable(Object receiver,
                                       long index)
```
    Returns true if a given array element index is existing and removable. This method may only return true if InteropLibrary.hasArrayElements(Object) returns true as well and InteropLibrary.isArrayElementInsertable(Object, long)} returns false. Invoking this message does not cause any observable side-effects. Returns false by default.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.removeArrayElement(Object, long)
  - isArrayElementWritable
```
public final boolean isArrayElementWritable(Object receiver,
                                            long index)
```
    Returns true if the array element is modifiable or insertable.
    
    Since:
    
    19.0
  - isArrayElementExisting
```
public final boolean isArrayElementExisting(Object receiver,
                                            long index)
```
    Returns true if the array element is existing. An array element is existing if it is, modifiable, readable or removable.
    
    Since:
    
    19.0
  - isPointer
```
public boolean isPointer(Object receiver)
```
    Returns true if the receiver value represents a native pointer. Native pointers are represented as 64 bit pointers. Invoking this message does not cause any observable side-effects. Returns false by default.
    It is expected that objects should only return true if the native pointer value corresponding to this object already exists, and obtaining it is a cheap operation. If an object can be transformed to a pointer representation, but this hasn't happened yet, the object is expected to return false with InteropLibrary.isPointer(Object), and wait for the InteropLibrary.toNative(Object) message to trigger the transformation.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.asPointer(Object), InteropLibrary.toNative(Object)
  - asPointer
```
public long asPointer(Object receiver)
               throws UnsupportedMessageException
```
    Returns the pointer value as long value if the receiver represents a pointer like value.
    
    Throws:
    
    UnsupportedMessageException - if and only if InteropLibrary.isPointer(Object) returns false for the same receiver.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isPointer(Object)
  - toNative
```
public void toNative(Object receiver)
```
    Transforms a receiver to a value that represents a raw native pointer. After the transformation, the provided receiver returns true for InteropLibrary.isPointer(Object) and can be unwrapped using the InteropLibrary.asPointer(Object) message.
    
    Since:
    
    19.0
    
    See Also:
    
    InteropLibrary.isPointer(Object), InteropLibrary.asPointer(Object)
  - asInstant
```
public Instant asInstant(Object receiver)
                  throws UnsupportedMessageException
```
    Returns the receiver as instant if this object represents an instant. If a value is an instant then it is also a date, time and timezone. Using this method may be more efficient than reconstructing the timestamp from the date, time and timezone data.
    Implementers should implement this method if they can provide a more efficient conversion to Instant than reconstructing it from date, time and timezone date. Implementers must ensure that the following Java code snippet always holds:
```
 ZoneId zone = getTimeZone(receiver);
 LocalDate date = getDate(receiver);
 LocalTime time = getTime(receiver);
 assert ZonedDateTime.of(date, time, zone).toInstant().equals(getInstant(receiver));
 
```
    Throws:
    
    UnsupportedMessageException - if InteropLibrary.isInstant(Object) returns false.
    
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    InteropLibrary.isDate(Object), InteropLibrary.isTime(Object), InteropLibrary.isTimeZone(Object)
  - isInstant
```
public final boolean isInstant(Object receiver)
```
    Returns true if the receiver represents an instant. If a value is an instant then it is also a date, time and timezone. This method is short-hand for:
```
 isDate(v) && isTime(v) && isTimeZone(v)
 
```
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    InteropLibrary.isDate(Object), InteropLibrary.isTime(Object), InteropLibrary.isInstant(Object), InteropLibrary.asInstant(Object)
  - isTimeZone
```
public boolean isTimeZone(Object receiver)
```
    Returns true if this object represents a timezone, else false. The interpretation of timezone objects may vary:
    - If InteropLibrary.isDate(Object) and InteropLibrary.isTime(Object) return true, then the returned date or time information is aware of this timezone.
    - If InteropLibrary.isDate(Object) and InteropLibrary.isTime(Object) returns false, then it represents just timezone information.
    Objects with only time or only date information must not have timezone information attached, as aware date or time information always consist of both date and time. If this rule is violated then an AssertionError is thrown if assertions are enabled.
    If this method is implemented then also InteropLibrary.asTimeZone(Object) must be implemented.
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    InteropLibrary.asTimeZone(Object), InteropLibrary.asInstant(Object)
  - asTimeZone
```
public ZoneId asTimeZone(Object receiver)
                  throws UnsupportedMessageException
```
    Returns the receiver as timestamp if this object represents a timezone.
    
    Throws:
    
    UnsupportedMessageException - if InteropLibrary.isTimeZone(Object) returns false .
    
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    InteropLibrary.isTimeZone(Object)
  - isDate
```
public boolean isDate(Object receiver)
```
    Returns true if this object represents a date, else false. If the receiver is also a timezone then the date is aware, otherwise it is naive.
    
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    InteropLibrary.asDate(Object)
  - asDate
```
public LocalDate asDate(Object receiver)
                 throws UnsupportedMessageException
```
    Returns the receiver as date if this object represents a date. The returned date is either aware if the receiver has a timezone otherwise it is naive.
    
    Throws:
    
    UnsupportedMessageException - if InteropLibrary.isDate(Object) returns false.
    
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    InteropLibrary.isDate(Object)
  - isTime
```
public boolean isTime(Object receiver)
```
    Returns true if this object represents a time, else false. If the receiver is also a timezone then the time is aware, otherwise it is naive.
    
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    InteropLibrary.asTime(Object)
  - asTime
```
public LocalTime asTime(Object receiver)
                 throws UnsupportedMessageException
```
    Returns the receiver as time if this object represents a time. The returned time is either aware if the receiver has a timezone otherwise it is naive.
    
    Throws:
    
    UnsupportedMessageException - if InteropLibrary.isTime(Object) returns false.
    
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    InteropLibrary.isTime(Object)
  - isDuration
```
public boolean isDuration(Object receiver)
```
    Returns true if this object represents a duration, else false.
    
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    Duration, InteropLibrary.asDate(Object)
  - asDuration
```
public Duration asDuration(Object receiver)
                    throws UnsupportedMessageException
```
    Returns the receiver as duration if this object represents a duration.
    
    Throws:
    
    UnsupportedMessageException - if InteropLibrary.isDuration(Object) returns false .
    
    Since:
    
    20.0.0 beta 2
    
    See Also:
    
    InteropLibrary.isDuration(Object)
  - getFactory
```
public static LibraryFactory<InteropLibrary> getFactory()
```
    Returns the library factory for the interop library. Short-cut for ResolvedLibrary.resolve(InteropLibrary.class).
    
    Since:
    
    19.0
    
    See Also:
    
    LibraryFactory.resolve(Class)
  - assertAdopted
```
protected final boolean assertAdopted()
```
    Utility for libraries to require adoption before cached versions of nodes can be executed. Only failes if assertions (-ea) are enabled.
    
    Since:
    
    19.0

Class InteropLibrary

Naive and aware dates and times

Nested Class Summary

Nested classes/interfaces inherited from class com.oracle.truffle.api.nodes.Node

Constructor Summary

Method Summary

Methods inherited from class com.oracle.truffle.api.library.Library

Methods inherited from class com.oracle.truffle.api.nodes.Node

Methods inherited from class java.lang.Object

Constructor Detail

InteropLibrary

Method Detail

isNull

isBoolean

asBoolean

isExecutable

execute

isInstantiable

instantiate

isString

asString

isNumber

fitsInByte

fitsInShort

fitsInInt

fitsInLong

fitsInFloat

fitsInDouble

asByte

asShort

asInt

asLong

asFloat

asDouble

hasMembers

getMembers

getMembers

isMemberReadable

readMember

isMemberModifiable

isMemberInsertable

writeMember

isMemberRemovable

removeMember

isMemberInvocable

invokeMember

isMemberInternal

isMemberWritable

isMemberExisting

hasMemberReadSideEffects

hasMemberWriteSideEffects

hasArrayElements

readArrayElement

getArraySize

isArrayElementReadable

writeArrayElement

removeArrayElement

isArrayElementModifiable

isArrayElementInsertable

isArrayElementRemovable

isArrayElementWritable

isArrayElementExisting

isPointer

asPointer

toNative

asInstant

isInstant

isTimeZone

asTimeZone

isDate

asDate

isTime

asTime

isDuration

asDuration

getFactory

assertAdopted