PermissionError

class PermissionError(message: String?, cause: Throwable?, contexts: Array<ExecutionContext>, operation: PermissionError.Operation, permission: PermissionError.Permission, culprit: Term, extraData: Term?) : PrologError
Content copied to clipboard

A permission error occurs when an attempt to perform a prohibited operation is made

Parameters

message

the detail message string.

cause

the cause of this exception.

contexts

a stack of contexts localising the exception

operation

the operation which caused the error

permission

the type of the tried permission

extraData

the possible extra data to be carried with the error

Constructors

PermissionError
Link copied to clipboard
common
fun PermissionError(message: String? = null, cause: Throwable? = null, context: ExecutionContext, operation: PermissionError.Operation, permission: PermissionError.Permission, culprit: Term, extraData: Term? = null)
Content copied to clipboard
PermissionError
Link copied to clipboard
common
fun PermissionError(message: String? = null, cause: Throwable? = null, contexts: Array<ExecutionContext>, operation: PermissionError.Operation, permission: PermissionError.Permission, culprit: Term, extraData: Term? = null)
Content copied to clipboard
the detail message string.

Types

Companion
Link copied to clipboard
common
object Companion
Content copied to clipboard
Operation
Link copied to clipboard
common
enum Operation : Enum<PermissionError.Operation> , ToTermConvertible
Content copied to clipboard
A class describing the operation which caused the error
Permission
Link copied to clipboard
common
enum Permission : Enum<PermissionError.Permission> , ToTermConvertible
Content copied to clipboard
A class describing the type of the tried permission

Functions

pushContext
Link copied to clipboard
common
open override fun pushContext(newContext: ExecutionContext): PermissionError
Content copied to clipboard
toString
Link copied to clipboard
common
open override fun toString(): String
Content copied to clipboard
updateContext
Link copied to clipboard
common
open override fun updateContext(newContext: ExecutionContext, index: Int): PermissionError
Content copied to clipboard
Creates a new exception instance with the context with in position index updated to newContext.
updateLastContext
Link copied to clipboard
common
open override fun updateLastContext(newContext: ExecutionContext): PermissionError
Content copied to clipboard

Properties

cause
Link copied to clipboard
common
open override val cause: Throwable?
Content copied to clipboard
context
Link copied to clipboard
common
val context: ExecutionContext
Content copied to clipboard
contexts
Link copied to clipboard
common
val contexts: Array<ExecutionContext>
Content copied to clipboard
a stack of contexts localising the exception
culprit
Link copied to clipboard
common
val culprit: Term
Content copied to clipboard
errorStruct
Link copied to clipboard
common
val errorStruct: Struct
Content copied to clipboard
The error Struct as described in Prolog standard: error(error_type, error_extra)
extraData
Link copied to clipboard
common
open val extraData: Term? = null
Content copied to clipboard
The possible extra data to be carried with the error
message
Link copied to clipboard
common
open override val message: String?
Content copied to clipboard
operation
Link copied to clipboard
common
val operation: PermissionError.Operation
Content copied to clipboard
the operation which caused the error
permission
Link copied to clipboard
common
val permission: PermissionError.Permission
Content copied to clipboard
the type of the tried permission
prologStackTrace
Link copied to clipboard
common
val prologStackTrace: List<Struct>
Content copied to clipboard
The exception stacktrace; shorthand for context.prologStackTrace
type
Link copied to clipboard
common
open override val type: Struct
Content copied to clipboard
The error type structure