DataException: The DataException hierarchy

In jefferys/Exception: Classed exception object hierarchy

Description

DataExceptions and their sub-classes describe problems with data values, names, or formats. Subclasses extended the specificity of the DataException. Each takes a data argument and possibly others. See Exception. These exceptions are intended to be signaled, i.e. with stop and exist both to provide pre-defined error messages and so that handlers in try/catch blocks have latitude to choose what granularity of exception to catch.

Usage

DataException(data = NA, message = "*", call = NULL,
  package = packageName(), ...)

FileFormatException(path = NA, line = NA, data = NA, message = "*",
  call = NULL, package = packageName(), ...)

EmptyFileException(path = NA, data = NA, line = NA, message = "*",
  call = NULL, package = packageName(), ...)

FileNotEmptyException(path = NA, data = NA, line = NA, message = "*",
  call = NULL, package = packageName(), ...)

Arguments

data	The data element associated with an exception. Format varies and should be described in subclass documentation. This may be NA but should not be NULL. Accessible via the the exceptionData S3 accessor.
message	The message associated with the exception, for reading by humans. The default message is usually good enough, but can be overridden through this parameter if needed. When constructed inside packages, the message displayed will have the name of the package prepended as '[package] message' due to conditionMessage being over-ridden for Exception subclasses.
call	The call or call stack associated with the exception. By default this is NUL. Can be overridden to provide the sys.calls call stack or a single sys.call.
package	The package where this exception is generated. May be NULL when exceptions are generated and signaled from interactive or script level code and not from a package. Attempts to guess the package by default. Will usually include the package in the displayed message.
...	Additional arguments defining arg= value data to include in the Exception (accessible as list elements, but preferably by S3 accessor functions).
path	The path associated with an exception, as a one element character vector This is required for a FileFormatException or sub-class. It may be NA but should not be NULL. Accessible via the the exceptionPath S3 accessor.
line	The line associated with an exception, as a one element integer vector This is required for a FileFormatException or sub-class. It may be NA but should not be NULL. Accessible via the the exceptionLine S3 accessor.

Value

An DataException or descendant describing some problematic event involving a data values, names, or formats. Always is/extends class c( "DataException", "Exception", "condition" ).

Functions

• DataException: This exception and sub-classes are Exceptions that describe problems with data values, names, or formats.

  • message: "[package] A DataException occurred."

  • class: c( "DataException", "Exception", "condition" )

  • data: Defaults: data = NA.

• FileFormatException: This exception and sub-classes are Exceptions that describe problems with data files

  • message: "[package] A FileFormatException occurred at line line in file: "file". (Running in: "getwd()"). That line began: "first 80 char"."

  • class: c( "FileFormatException", "DataException", "Exception", "condition" )

  • data: Defaults: path = NA, line = NA, data = NA.

• EmptyFileException: This exception indicates a data file was unexpectedly empty

  • message: [package] An EmptyFileException occurred. File is unexpectedly empty: "file". (Running in: "getwd()").

  • class: c( "EmptyFileException", "FileFormatException", "DataException", "Exception", "condition" )

  • data: Defaults: path = NA, data= NA, line= NA.

• FileNotEmptyException: This exception indicates a data file that should have been empty but wasn't.

  • message: [package] A FileNotEmptyException occurred. File was expectedly to be empty but wasn't: "file". (Running in: "getwd()").

  • class: c( "FileNotEmptyException", "FileFormatException", "DataException", "Exception", "condition" )

  • data: Defaults: path = NA, data= NA, line= NA.

See Also

condition, conditionMessage(), conditionCall, Exception, exceptionPackage, exceptionData

Examples

dEx <- IOException()
conditionMessage(dEx)
conditionCall(dEx)
exceptionPackage(dEx)
exceptionData(dEx)

jefferys/Exception documentation built on May 19, 2019, 3:59 a.m.