Automatic generation produced by ISE Eiffel
note description: "Summary description for {XML_DOCUMENT}." date: "$Date: 2017-05-19 02:31:56 -0800 (Fri, 19 May 2017) $" revision: "$Revision: 100418 $" class interface XML_DOCUMENT create make -- Create root node. make_with_count (a_count: INTEGER_32) -- Create root node and initialize for a_count childrens require a_count_positive: a_count >= 0 make_with_root_named (a_name: READABLE_STRING_32; a_ns: XML_NAMESPACE) -- Create root node, with a root_element -- with given name. require not_void: a_name /= Void not_empty: a_name.count > 0 ensure root_element_name_set: root_element.has_same_name (a_name) make_with_root_named_and_count (a_name: READABLE_STRING_32; a_ns: XML_NAMESPACE; a_count: INTEGER_32) -- Create root node, with a root_element with given name, -- and initialize for a_count childrens require not_void: a_name /= Void not_empty: a_name.count > 0 a_count_positive: a_count >= 0 ensure root_element_name_set: root_element.has_same_name (a_name) feature -- Initialization initialize -- Initialize -- (from XML_COMPOSITE) initialize_with_count (a_count: INTEGER_32) -- Initialize internal data -- (from XML_COMPOSITE) require -- from XML_COMPOSITE a_count_positive: a_count >= 0 feature -- Access after: BOOLEAN -- (from XML_COMPOSITE) count: INTEGER_32 -- (from XML_COMPOSITE) element_by_name (a_name: READABLE_STRING_32): detachable XML_ELEMENT -- Direct child element with name a_name; -- If there are more than one element with that name, anyone may be returned. -- Return Void if no element with that name is a child of current node. require -- from XML_COMPOSITE a_name_not_void: a_name /= Void ensure -- from XML_COMPOSITE element_not_void: has_element_by_name (a_name) = (Result /= Void) ensure then root_element: has_element_by_name (a_name) implies Result = root_element element_by_qualified_name (a_uri: READABLE_STRING_32; a_name: READABLE_STRING_32): detachable XML_ELEMENT -- Root element, if name matches, Void otherwise. require -- from XML_COMPOSITE a_uri_not_void: a_uri /= Void a_name_not_void: a_name /= Void ensure -- from XML_COMPOSITE element_not_void: has_element_by_qualified_name (a_uri, a_name) = (Result /= Void) ensure then root_element: has_element_by_qualified_name (a_uri, a_name) implies Result = root_element elements: LIST [XML_ELEMENT] -- List of all direct child elements in current element -- (Create a new list at each call.) -- (from XML_COMPOSITE) ensure -- from XML_COMPOSITE not_void: Result /= Void first: XML_NODE -- (from XML_COMPOSITE) forth -- (from XML_COMPOSITE) generating_type: TYPE [detachable XML_DOCUMENT] -- 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 has_element_by_name (a_name: READABLE_STRING_32): BOOLEAN -- Has current node at least one direct child -- element with the name a_name? -- (Namespace is ignored on the root node because the -- root element defines the current namespace.) require -- from XML_COMPOSITE a_name_not_void: a_name /= Void ensure then definition: Result = root_element.has_same_name (a_name) has_element_by_qualified_name (a_uri: READABLE_STRING_32; a_name: READABLE_STRING_32): BOOLEAN -- Is this the qualified name of the root element? require -- from XML_COMPOSITE a_uri_not_void: a_uri /= Void a_name_not_void: a_name /= Void ensure then definition: Result = root_element.has_qualified_name (a_uri, a_name) item_for_iteration: XML_NODE -- (from XML_COMPOSITE) last: XML_NODE -- (from XML_COMPOSITE) new_cursor: XML_COMPOSITE_CURSOR -- Fresh cursor associated with current structure -- (from XML_COMPOSITE) ensure -- from ITERABLE result_attached: Result /= Void parent: detachable XML_COMPOSITE -- Parent of current node; -- Void if current node is root -- (from XML_NODE) remove_at_cursor (c: like new_cursor) -- (from XML_COMPOSITE) root_element: XML_ELEMENT -- Root element of current document. start -- (from XML_COMPOSITE) wipe_out -- (from XML_COMPOSITE) xml_declaration: detachable XML_DECLARATION -- Optional <?xml declaration 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: XML_DOCUMENT): 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: XML_DOCUMENT): 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: XML_DOCUMENT): 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 debug_output: STRING_8 -- String that should be displayed in debugger to represent Current. -- (from XML_NODE) ensure -- from DEBUG_OUTPUT result_not_void: Result /= Void debug_output_representation (s: READABLE_STRING_32): STRING_8 -- (from XML_NODE) 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 -- Element change attach_parent (a_parent: attached like parent) -- Set `parent` to a_parent. -- (from XML_NODE) require -- from XML_NODE a_parent_attached: a_parent /= Void ensure -- from XML_NODE parent_set: parent = a_parent force_first (a_node: XML_NODE) -- Was declared in {XML_COMPOSITE} as synonym of `put_first`. -- (from XML_COMPOSITE) force_last (a_node: XML_NODE) -- (from XML_COMPOSITE) put_first (a_node: XML_NODE) -- Was declared in {XML_COMPOSITE} as synonym of `force_first`. -- (from XML_COMPOSITE) put_last (a_node: XML_NODE) -- (from XML_COMPOSITE) set_parent (a_parent: attached like parent) -- Set `parent` to a_parent. -- (from XML_NODE) require -- from XML_NODE a_parent_attached: a_parent /= Void not_root_node: not is_root_node ensure -- from XML_NODE parent_set: parent = a_parent feature -- Duplication copy (other: XML_DOCUMENT) -- 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: XML_DOCUMENT) -- 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: XML_DOCUMENT -- 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: XML_DOCUMENT) -- 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: XML_DOCUMENT -- 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: XML_DOCUMENT -- 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 XML_DOCUMENT -- 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 -- Element change using index put (a_node: XML_NODE; i: INTEGER_32) -- Add v at the index i -- (from XML_COMPOSITE) require -- from XML_COMPOSITE valid_index: valid_index (i) remove (i: INTEGER_32) -- Remove item at index i. -- (from XML_COMPOSITE) require -- from XML_COMPOSITE valid_index: valid_index (i) valid_index (i: INTEGER_32): BOOLEAN -- Is i a valid index? -- (from XML_COMPOSITE) 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 -- Processing process_children (a_processor: XML_NODE_VISITOR) -- Process direct children. -- (from XML_COMPOSITE) require -- from XML_COMPOSITE a_processor_not_void: a_processor /= Void process_children_recursive (a_processor: XML_NODE_VISITOR) -- Process direct and indirect children. -- (from XML_COMPOSITE) require -- from XML_COMPOSITE processor_not_void: a_processor /= Void feature -- Setting set_root_element (an_element: like root_element) -- Set root element. require an_element_not_void: an_element /= Void ensure root_element_parent: root_element.parent = Current root_element_set: root_element = an_element last_set: last = root_element set_xml_declaration (xml: like xml_declaration) -- Set `xml_declaration` to xml feature -- Status is_root_node: BOOLEAN -- Is current node the root node? -- (from XML_NODE) ensure -- from XML_NODE definition: Result = (parent = Void) level: INTEGER_32 -- Depth at which current node appears relative to its root -- (The root node has the level 1.) -- (from XML_NODE) ensure -- from XML_NODE Result > 0 parent_element: detachable XML_ELEMENT -- Parent element. -- (from XML_NODE) require -- from XML_NODE not_root_node: not is_root_node not_root_element: attached parent as l_parent and then not l_parent.is_root_node ensure -- from XML_NODE result_not_void: not is_root_node implies Result /= Void feature -- Text text: detachable STRING_32 -- Concatenation of all texts directly found in -- current element; Void if no text found -- (Return a new string at each call.) -- (from XML_COMPOSITE) feature -- Visitor processing process (a_processor: XML_NODE_VISITOR) -- Process current node with a_processor. require -- from XML_NODE a_processor_not_void: a_processor /= Void process_to_events (a_filter: XML_CALLBACKS) -- Traverse the document and issue events -- on event consumer. require a_filter_not_void: a_filter /= Void invariant root_element_not_void: root_element /= Void -- from XML_COMPOSITE elements_attached: internal_nodes /= Void -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2012, 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 XML_DOCUMENT -- Generated by Eiffel Studio --
For more details: eiffel.org