org.graalvm.compiler.nodes.spi

Interface WordVerification

All Known Implementing Classes:

WordVerificationImpl

public interface WordVerification

Provides a capability to verify that types represent or do not represent raw words (as opposed to Objects).

All methods will either return true in case the assertion holds or throw an exception if it does not. Users are not supposed to catch the exception and make decisions based on it. This is a debugging tool. Only use it for assertions and verification.

Motivation

This interface exists to avoid exposing WordTypes in CoreProviders. Word values must be transformed to other types at the very beginning of the pipeline (i.e., during graph building). WordVerification is used to detect when this invariant is violated and to issue proper error messages.

Method Summary

Modifier and Type	Method and Description
boolean	guaranteeNotWord(JavaType type) Verifies that a given type is not a word type.
boolean	guaranteeWord(JavaType type) Verifies that a given type is a word type.

Method Detail

guaranteeWord

boolean guaranteeWord(JavaType type)

Verifies that a given type is a word type.

Returns:

true

Throws:

Error - if the assertion does not hold

guaranteeNotWord

boolean guaranteeNotWord(JavaType type)

Verifies that a given type is not a word type.

Returns:

true

Throws:

Error - if the assertion does not hold