Automatic generation produced by ISE Eiffel

Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:
note description: "XML file preference storage implementation." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2015-11-09 07:14:49 -0900 (Mon, 09 Nov 2015) $" revision: "$Revision: 98094 $" class interface PREFERENCES_STORAGE_XML create make_empty -- Create preferences storage in XML file.  File will be created based on name of application. -- For operating systems which support it it will stored in the users home directory.  For operating -- systems that do not support home directories it will be stored in the current working directory. ensure -- from PREFERENCES_STORAGE_I has_location: location /= Void default_version: version.same_string (default_version) make_versioned (a_version: attached like version) -- Create preferences storage with a_version as version. -- Location to store preferences will be generated based on name of application. -- Redefine make_empty to change behavior. -- (from PREFERENCES_STORAGE_I) require -- from PREFERENCES_STORAGE_I a_version_not_void: a_version /= Void a_version_valid: valid_version (a_version) ensure -- from PREFERENCES_STORAGE_I has_location: location /= Void version_set: version = a_version make_with_location (a_location: READABLE_STRING_GENERAL) -- Create preference storage in the XML file at location a_location. -- If file does not exist create new one. require -- from PREFERENCES_STORAGE_I location_not_void: a_location /= Void location_not_empty: not a_location.is_empty ensure -- from PREFERENCES_STORAGE_I has_location: location /= Void location_set: location = a_location default_version: version.same_string (default_version) make_with_location_and_version (a_location: READABLE_STRING_GENERAL; a_version: attached like version) -- Create preference storage in the at location a_location with a_version as version. -- Try to read preference at a_location if it exists, if not create new one. -- Preferences will be stored in a_location between sessions, which is the -- path to either: -- * the root registry key where preferences are stored, -- * or the file where preferences are stored, -- depending on which storage is chosen (registry or xml ... ). -- Redefine make_with_location to change behavior. -- (from PREFERENCES_STORAGE_I) require -- from PREFERENCES_STORAGE_I location_not_void: a_location /= Void location_not_empty: not a_location.is_empty a_version_not_void: a_version /= Void a_version_valid: valid_version (a_version) ensure -- from PREFERENCES_STORAGE_I has_location: location /= Void location_set: location = a_location version_set: version = a_version feature -- Access default_version: IMMUTABLE_STRING_32 -- Default version if none specified. -- (from PREFERENCES_VERSIONS) generating_type: TYPE [detachable PREFERENCES_STORAGE_XML] -- 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 version: IMMUTABLE_STRING_32 -- Format version. -- (from PREFERENCES_STORAGE_I) Version_1_0: IMMUTABLE_STRING_32 -- (from PREFERENCES_VERSIONS) Version_2_0: IMMUTABLE_STRING_32 -- (from PREFERENCES_VERSIONS) 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: PREFERENCES_STORAGE_XML): 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: PREFERENCES_STORAGE_XML): 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: PREFERENCES_STORAGE_XML): 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)) valid_version (a_version: detachable IMMUTABLE_STRING_32): BOOLEAN -- Is a_version a supported version? -- (from PREFERENCES_VERSIONS) feature -- Duplication copy (other: PREFERENCES_STORAGE_XML) -- 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: PREFERENCES_STORAGE_XML) -- 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: PREFERENCES_STORAGE_XML -- 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: PREFERENCES_STORAGE_XML) -- 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: PREFERENCES_STORAGE_XML -- 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: PREFERENCES_STORAGE_XML -- 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 PREFERENCES_STORAGE_XML -- 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 -- Filters new_document_builder: XML_CALLBACKS_DOCUMENT -- New tree construction filter -- Was declared in XML_CALLBACKS_FILTER_FACTORY as synonym of new_tree_builder. -- (from XML_CALLBACKS_FILTER_FACTORY) ensure -- from XML_CALLBACKS_FILTER_FACTORY tree_builder_not_void: Result /= Void new_namespace_resolver: XML_NAMESPACE_RESOLVER -- New namespace resolver -- (from XML_CALLBACKS_FILTER_FACTORY) ensure -- from XML_CALLBACKS_FILTER_FACTORY namespace_resolver_not_void: Result /= Void new_null: XML_CALLBACKS_NULL -- New null callback consumer -- (from XML_CALLBACKS_FILTER_FACTORY) ensure -- from XML_CALLBACKS_FILTER_FACTORY null_callback_not_void: Result /= Void new_tree_builder: XML_CALLBACKS_DOCUMENT -- New tree construction filter -- Was declared in XML_CALLBACKS_FILTER_FACTORY as synonym of new_document_builder. -- (from XML_CALLBACKS_FILTER_FACTORY) ensure -- from XML_CALLBACKS_FILTER_FACTORY tree_builder_not_void: Result /= Void feature -- Filters to implement new_content_concatenator: XML_CONTENT_CONCATENATOR -- New content concatenation filter. -- (from XML_CALLBACKS_FILTER_FACTORY) ensure -- from XML_CALLBACKS_FILTER_FACTORY content_concatenator_not_void: Result /= Void new_indent_pretty_print: XML_INDENT_PRETTY_PRINT_FILTER -- Indenting pretty print filter -- (from XML_CALLBACKS_FILTER_FACTORY) ensure -- from XML_CALLBACKS_FILTER_FACTORY indent_pretty_print_not_void: Result /= Void new_pretty_print: XML_PRETTY_PRINT_FILTER -- New pretty printer (to standard io) -- (from XML_CALLBACKS_FILTER_FACTORY) ensure -- from XML_CALLBACKS_FILTER_FACTORY pretty_print_not_void: Result /= Void new_xmlns_generator: XML_XMLNS_GENERATOR -- New xmlns: generator (opposite of namespace resolver) -- (from XML_CALLBACKS_FILTER_FACTORY) ensure -- from XML_CALLBACKS_FILTER_FACTORY xmlns_generator_not_void: Result /= Void feature -- Markers fixme (comment: READABLE_STRING_8) -- Mark code that has to be "fixed" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement (comment: READABLE_STRING_8) -- Mark code that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER instance_free: class to_implement_assertion (comment: READABLE_STRING_8): BOOLEAN -- Mark assertion that has to be "implemented" with comment. -- (from REFACTORING_HELPER) require -- from REFACTORING_HELPER comment_not_void: comment /= Void ensure -- from REFACTORING_HELPER 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 -- Pipes callbacks_pipe (a: ARRAY [XML_CALLBACKS_FILTER]): XML_CALLBACKS -- Make a pipe, -- eg << new_tag_checker, new_pretty_print >> -- return first item of pipe. -- (from XML_CALLBACKS_FILTER_FACTORY) require -- from XML_CALLBACKS_FILTER_FACTORY a_not_void: a /= Void a_not_empty: a.count > 0 ensure -- from XML_CALLBACKS_FILTER_FACTORY pipe_not_void: Result /= Void standard_callbacks_pipe (a: ARRAY [XML_CALLBACKS_FILTER]): XML_CALLBACKS -- Add elements to standard validation pipe, which -- begins with: --  namespace resolver -> stop on error -- (from XML_CALLBACKS_FILTER_FACTORY) require -- from XML_CALLBACKS_FILTER_FACTORY a_not_void: a /= Void ensure -- from XML_CALLBACKS_FILTER_FACTORY pipe_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 has_session_values: session_values /= Void has_xml_structure: xml_structure /= Void -- from PREFERENCES_STORAGE_I has_location: location /= Void preferences_not_void_when_initialized: initialized implies preferences /= Void -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2015, 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 PREFERENCES_STORAGE_XML
Classes Clusters Cluster hierarchy Chart Relations Flat contracts Go to:

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