Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "Serialize and deserialize multiple objects into one file." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2017-03-23 11:18:26 -0800 (Thu, 23 Mar 2017) $" revision: "$Revision: 100033 $" class interface SED_MULTI_OBJECT_SERIALIZATION create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) feature -- Access deserialized_object: detachable ANY -- Last deserialized object error_message: STRING_32 -- Reason for failure generating_type: TYPE [detachable SED_MULTI_OBJECT_SERIALIZATION] -- 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 last_file_position: INTEGER_32 -- Position after last serialization 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_MULTI_OBJECT_SERIALIZATION): 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_MULTI_OBJECT_SERIALIZATION): 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_MULTI_OBJECT_SERIALIZATION): 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)) successful: BOOLEAN -- Was last retrieval successful? feature -- Duplication copy (other: SED_MULTI_OBJECT_SERIALIZATION) -- 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_MULTI_OBJECT_SERIALIZATION) -- 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_MULTI_OBJECT_SERIALIZATION -- 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_MULTI_OBJECT_SERIALIZATION) -- 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_MULTI_OBJECT_SERIALIZATION -- 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_MULTI_OBJECT_SERIALIZATION -- 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_MULTI_OBJECT_SERIALIZATION -- 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 -- Basic Operations deserialize (path: READABLE_STRING_GENERAL; a_pos: INTEGER_32) -- Deserialize object previously serialized in path at position a_pos. require non_void_path: path /= Void valid_path: (create {RAW_FILE}.make_with_name (path)).exists ensure deserialized_object_set_if_no_error: successful implies deserialized_object /= Void serialize (a: ANY; path: READABLE_STRING_GENERAL; is_appending: BOOLEAN) -- Serialize object a at the end of file path if is_appending, otherwise -- reset content of path. -- Set last_file_position after storing. require non_void_object: a /= Void non_void_path: path /= Void 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 feature -- Serialization routines basic_store (an_object: ANY; a_writer: SED_READER_WRITER; a_optimized_for_retrieval: BOOLEAN) -- Serialization of an_object using a_writer. -- Object stored can only be retrieved by execution of same program executable. -- (from SED_STORABLE_FACILITIES) require -- from SED_STORABLE_FACILITIES an_object_not_void: an_object /= Void a_writer_not_void: a_writer /= Void a_writer_ready: a_writer.is_ready_for_writing retrieved (a_reader: SED_READER_WRITER; a_is_gc_enabled: BOOLEAN): detachable ANY -- Deserialization of object from a_reader. -- Garbage collection will be enabled if a_is_gc_enabled. -- (from SED_STORABLE_FACILITIES) require -- from SED_STORABLE_FACILITIES a_reader_not_void: a_reader /= Void a_reader_ready: a_reader.is_ready_for_reading retrieved_errors: detachable ARRAYED_LIST [SED_ERROR] -- Errors set from last call to retrieved. -- (from SED_STORABLE_FACILITIES) retrieved_from_medium (a_medium: IO_MEDIUM): detachable ANY -- Deserialization of object from a_reader. -- (from SED_STORABLE_FACILITIES) require -- from SED_STORABLE_FACILITIES a_medium_not_void: a_medium /= Void a_medium_open_for_reading: a_medium.is_open_read a_medium_support_storable: a_medium.support_storable session_store (an_object: ANY; a_writer: SED_READER_WRITER; a_optimized_for_retrieval: BOOLEAN) -- Serialization of an_object using a_writer. -- Object stored can only be retrieved during current program execution. -- (from SED_STORABLE_FACILITIES) require -- from SED_STORABLE_FACILITIES an_object_not_void: an_object /= Void a_writer_not_void: a_writer /= Void a_writer_ready: a_writer.is_ready_for_writing store (an_object: ANY; a_writer: SED_READER_WRITER) -- Serialization of an_object using a_writer. -- Object stored can only be retrieved by programs having the same set of types. -- (from SED_STORABLE_FACILITIES) require -- from SED_STORABLE_FACILITIES an_object_not_void: an_object /= Void a_writer_not_void: a_writer /= Void a_writer_ready: a_writer.is_ready_for_writing store_in_medium (an_object: ANY; a_medium: IO_MEDIUM) -- Serialization of an_object in a_medium -- Object stored can only be retrieved by programs having the same set of types. -- (from SED_STORABLE_FACILITIES) require -- from SED_STORABLE_FACILITIES an_object_not_void: an_object /= Void a_medium_not_void: a_medium /= Void a_medium_writable: a_medium.is_open_write a_medium_support_storable: a_medium.support_storable feature -- Storable type Eiffel_basic_store: NATURAL_32 = 2 -- (from SED_STORABLE_FACILITIES) Eiffel_independent_store: NATURAL_32 = 3 -- (from SED_STORABLE_FACILITIES) Eiffel_recoverable_store: NATURAL_32 = 4 -- Various type of storable mechanism. -- (from SED_STORABLE_FACILITIES) Eiffel_session_store: NATURAL_32 = 1 -- (from SED_STORABLE_FACILITIES) 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-2017, 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_MULTI_OBJECT_SERIALIZATION
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

-- Generated by Eiffel Studio --
For more details: eiffel.org