Standard class for error messages

Introduced properties

fun cause: nullable Error

core :: Error :: cause

An original error that caused the creation of this error, if any.
fun cause=(cause: nullable Error)

core :: Error :: cause=

An original error that caused the creation of this error, if any.
init defaultinit(message: String)

core :: Error :: defaultinit

fun message: String

core :: Error :: message

A short human-readable error message.
protected fun message=(message: String)

core :: Error :: message=

A short human-readable error message.

Redefined properties

redef type SELF: Error

core $ Error :: SELF

Type of this instance, automatically specialized in every class
redef fun core_serialize_to(v: Serializer)

serialization :: serialization_core $ Error :: core_serialize_to

Actual serialization of self to serializer
redef init from_deserializer(v: Deserializer)

serialization :: serialization_core $ Error :: from_deserializer

Create an instance of this class from the deserializer
redef fun to_s: String

core $ Error :: to_s

User readable representation of self.

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
fun cause: nullable Error

core :: Error :: cause

An original error that caused the creation of this error, if any.
fun cause=(cause: nullable Error)

core :: Error :: cause=

An original error that caused the creation of this error, if any.
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
init defaultinit(message: String)

core :: Error :: defaultinit

init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun message: String

core :: Error :: message

A short human-readable error message.
protected fun message=(message: String)

core :: Error :: message=

A short human-readable error message.
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram core::Error Error serialization::Serializable Serializable core::Error->serialization::Serializable core::Object Object serialization::Serializable->core::Object ...core::Object ... ...core::Object->core::Object serialization::AttributeError AttributeError serialization::AttributeError->core::Error core::IOError IOError core::IOError->core::Error json::JsonParseError JsonParseError json::JsonParseError->core::Error ini::IniError IniError ini::IniError->core::Error github::GithubError GithubError github::GithubError->core::Error json::JsonKeyError JsonKeyError json::JsonKeyError->core::Error neo4j::NeoError NeoError neo4j::NeoError->core::Error sax::SAXParseException SAXParseException sax::SAXParseException->core::Error serialization::AttributeTypeError AttributeTypeError serialization::AttributeTypeError->serialization::AttributeError serialization::AttributeMissingError AttributeMissingError serialization::AttributeMissingError->serialization::AttributeError serialization::AttributeTypeError... ... serialization::AttributeTypeError...->serialization::AttributeTypeError serialization::AttributeMissingError... ... serialization::AttributeMissingError...->serialization::AttributeMissingError github::GithubAPIError GithubAPIError github::GithubAPIError->github::GithubError github::GithubDeserializerErrors GithubDeserializerErrors github::GithubDeserializerErrors->github::GithubError github::GithubAPIError... ... github::GithubAPIError...->github::GithubAPIError github::GithubDeserializerErrors... ... github::GithubDeserializerErrors...->github::GithubDeserializerErrors

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Children

abstract class AttributeError

serialization :: AttributeError

Deserialization error related to an attribute of receiver
class GithubError

github :: GithubError

An Error returned by GithubAPI
class IOError

core :: IOError

Any kind of error that could be produced by an operation on Streams
class IniError

ini :: IniError

Error for IniFile parsing
class JsonKeyError

json :: JsonKeyError

Key access error
class JsonParseError

json :: JsonParseError

JSON format error at parsing
class NeoError

neo4j :: NeoError

An error thrown by the neo4j API.
class SAXParseException

sax :: SAXParseException

Encapsulates an XML parse error or warning.

Descendants

class AttributeMissingError

serialization :: AttributeMissingError

Missing attribute at deserialization
class AttributeTypeError

serialization :: AttributeTypeError

Invalid dynamic type for a deserialized attribute
class GithubAPIError

github :: GithubAPIError

An Error returned by https://api.github.com
class GithubDeserializerErrors

github :: GithubDeserializerErrors

An Error returned while deserializing objects from the API

Class definitions

core $ Error
# Standard class for error messages
class Error
	# A short human-readable error message.
	#
	# This message is short and informative and could be displayed on the console, a dialog-box
	# or written in a log file.
	#
	# Message should be explicative, autonomous and do not depend on contextual information.
	#
	# Eg. instead of "Fatal error: cannot open file",
	# something like "File error, cannot open /some/path/document.ext, file not found." is preferred,
	# where the message is informative as it, and the severity of the error is not assumed:
	# while fatal for the library, it could be something benign for the program.
	var message: String

	# An original error that caused the creation of this error, if any.
	#
	# This is used to chain errors and track the implication of various sub-systems for a given error.
	#
	# When displaying an error the end user, causes can be recursively displayed.
	var cause: nullable Error = null is writable

	redef fun to_s do return message
end
lib/core/error.nit:17,1--40,3

serialization :: serialization_core $ Error
redef class Error
	super Serializable

	redef init from_deserializer(v)
	do
		v.notify_of_creation self

		var message = v.deserialize_attribute("message")
		if not message isa String then message = ""
		init message

		var cause = v.deserialize_attribute("cause")
		if cause isa nullable Error then self.cause = cause
	end

	redef fun core_serialize_to(v)
	do
		v.serialize_attribute("message", message)
		v.serialize_attribute("cause", cause)
	end
end
lib/serialization/serialization_core.nit:302,1--322,3