note description: "Objects that provide instances of {SED_ERROR}." legal: "See notice at end of class." status: "See notice at end of class." author: "Julian Rogers" last_editor: "$Author: alexk $" date: "$Date: 2020-05-19 14:32:38 +0000 (Tue, 19 May 2020) $" revision: "$Revision: 104260 $" class interface SED_ERROR_FACTORY create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access generating_type: TYPE [detachable SED_ERROR_FACTORY] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty new_attribute_count_mismatch (a_type_id: INTEGER_32; a_received_attribute_count: INTEGER_32): SED_ERROR -- Return an error representing an attribute count mismatch for type a_type with a received attribute count of a_received_attribute_count. require a_type_id_non_negative: a_type_id >= 0 ensure result_not_void: Result /= Void new_attribute_mismatch (a_type_id: INTEGER_32; a_attribute_name: STRING_8; a_attribute_type_id, a_received_attribute_type_id: INTEGER_32): SED_ERROR -- Return an error representing an attribute mismatch for attribute a_attribute_name of type a_type with require a_type_id_non_negative: a_type_id >= 0 a_attribute_name_not_void: a_attribute_name /= Void a_attribute_type_id_non_negative: a_attribute_type_id >= 0 a_received_attribute_type_id_non_negative: a_received_attribute_type_id >= 0 ensure result_not_void: Result /= Void new_exception_error (a_exception: EXCEPTION): SED_ERROR -- Generic error message when something fails internally require a_exception_not_void: a_exception /= Void ensure result_not_void: Result /= Void new_format_mismatch (a_old_version, a_new_version: NATURAL_32): SED_ERROR -- Return an error when the format is different from what we expected upon retrieval ensure result_not_void: Result /= Void new_format_mismatch_66: SED_ERROR -- Return an error when the format is not using is_for_fast_retrieval setting. ensure result_not_void: Result /= Void new_internal_error (a_msg: STRING_8): SED_ERROR -- Generic error message when something fails internally require a_msg_not_void: a_msg /= Void ensure result_not_void: Result /= Void new_invalid_object_error (a_obj: ANY): SED_ERROR -- Object a_obj was retrieved but is not valid. ensure result_not_void: Result /= Void new_missing_attribute_error (a_type_id: INTEGER_32; a_attribute_name: READABLE_STRING_8): SED_ERROR -- Return a error representing a missing attribute named a_attribute_name in type a_type. require a_type_id_non_negative: a_type_id >= 0 a_attribute_name_not_void: a_attribute_name /= Void ensure result_not_void: Result /= Void new_missing_type_error (a_stored_type, a_adapted_type: READABLE_STRING_8): SED_ERROR -- Return a error representing a missing type a_stored_type possibly adapted to a_adapted_type. require a_stored_type_not_void: a_stored_type /= Void a_adapted_type_not_void: a_adapted_type /= Void ensure result_not_void: Result /= Void new_object_mismatch_error (a_obj: ANY): SED_ERROR -- Object a_obj was retrieved but its content is still mismatched. ensure result_not_void: Result /= Void new_obsolete_storable_type: SED_ERROR -- Obsolete storable format is used. new_storable_version_mismatch_error (a_type_id: INTEGER_32; a_old_version_str: detachable STRING_8): SED_ERROR -- Return an error representing a mismatch in the storable_version attribute in type a_type. require a_type_id_non_negative: a_type_id >= 0 ensure result_not_void: Result /= Void new_unknown_attribute_type_error (a_type_id: INTEGER_32; a_attribute_name: READABLE_STRING_8): SED_ERROR -- Return a error representing an attribute whose type is unknown. require a_type_id_non_negative: a_type_id >= 0 a_attribute_name_not_void: a_attribute_name /= Void ensure result_not_void: Result /= Void new_unknown_storable_type: SED_ERROR -- Storable format could be read but is unknown. feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: SED_ERROR_FACTORY): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: SED_ERROR_FACTORY): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: SED_ERROR_FACTORY): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Duplication copy (other: SED_ERROR_FACTORY) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: SED_ERROR_FACTORY) -- Effect equivalent to that of: -- copy (other . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: SED_ERROR_FACTORY -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: SED_ERROR_FACTORY) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: SED_ERROR_FACTORY -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: SED_ERROR_FACTORY -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable SED_ERROR_FACTORY -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.default for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note library: "EiffelBase: Library of reusable components for Eiffel." copyright: "Copyright (c) 1984-2020, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class SED_ERROR_FACTORY
Generated by ISE EiffelStudio