Automatic generation produced by ISE Eiffel
note description: "Actions used by the various 'formatting' elements" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2013-05-20 15:15:17 -0800 (Mon, 20 May 2013) $" revision: "$Revision: 92557 $" class interface I18N_FORMATTING_ACTIONS create default_create -- Process instances of classes with no creation clause. -- (Default: do nothing.) -- (from ANY) feature -- Access generating_type: TYPE [detachable I18N_FORMATTING_ACTIONS] -- 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 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: I18N_FORMATTING_ACTIONS): 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: I18N_FORMATTING_ACTIONS): 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: I18N_FORMATTING_ACTIONS): 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: I18N_FORMATTING_ACTIONS) -- 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: I18N_FORMATTING_ACTIONS) -- 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: I18N_FORMATTING_ACTIONS -- 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: I18N_FORMATTING_ACTIONS) -- 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: I18N_FORMATTING_ACTIONS -- 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: I18N_FORMATTING_ACTIONS -- 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 I18N_FORMATTING_ACTIONS -- 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 -- Date related actions abbreviated_day_name_action (a_date: DATE; a_locale_info: I18N_LOCALE_INFO): STRING_32 -- Returns the abbreviated day name -- associated to formatting character abbreviated_day_name require a_date_exists: a_date /= Void a_locale_info_exists: a_locale_info /= Void ensure result_exists: Result /= Void abbreviated_month_name_action (a_date: DATE; a_locale_info: I18N_LOCALE_INFO): STRING_32 -- Returns the abbreviated month name -- associated to formatting character abbreviated_month_name require a_date_exists: a_date /= Void a_locale_info_exists: a_locale_info /= Void ensure result_exists: Result /= Void century_number_action (a_date: DATE): STRING_32 -- Returns the century number (year/100) as a 2-digit integer -- associated to formatting character century_number require a_date_exists: a_date /= Void ensure result_exists: Result /= Void day_name_action (a_date: DATE; a_locale_info: I18N_LOCALE_INFO): STRING_32 -- Returns the abbreviated day name -- associated to formatting character day_name require a_date_exists: a_date /= Void a_locale_info_exists: a_locale_info /= Void ensure result_exists: Result /= Void day_of_month_action (a_date: DATE): STRING_32 -- Returns day of the month as digits without -- leading zeros for single digit days. -- associated to formatting character day_of_month require a_date_exists: a_date /= Void ensure result_exists: Result /= Void day_of_month_padded_action (a_date: DATE): STRING_32 -- Returns the day of the month as a decimal number (range 01 to 31) -- associated to formatting character day_of_month_padded require a_date_exists: a_date /= Void ensure result_exists: Result /= Void day_of_week_0_action (a_date: DATE): STRING_32 -- Returns the day of the week as a decimal, -- range 0 to 6, Sunday being 0. -- associated to formatting character day_of_week_0 require a_date_exists: a_date /= Void ensure result_exists: Result /= Void day_of_week_action (a_date: DATE): STRING_32 -- Retunr the fay of the weel as a decimal number, -- range 1 to 7, Monday being 1 -- associated to formatting character day_of_week require a_date_exists: a_date /= Void ensure result_exists: Result /= Void day_of_year_action (a_date: DATE): STRING_32 -- Returns the day of the year as a decimal number (range 001 366) -- associated to formatting character day_of_year require a_date_exists: a_date /= Void ensure result_exists: Result /= Void iso_year_with_century_action (a_date: DATE): STRING_32 -- Same result as Year_4_action -- associated to formatting character iso_year_with_century require a_date_exists: a_date /= Void ensure result_exists: Result /= Void iso_year_without_century_action (a_date: DATE): STRING_32 -- Same result as Year_2_action -- associated to formatting character iso_year_without_century require a_date_exists: a_date /= Void ensure result_exists: Result /= Void month_action (a_date: DATE): STRING_32 -- Returns month as digits without leading zeros for single digit months. -- associated to formatting character month require a_date_exists: a_date /= Void ensure result_exists: Result /= Void month_name_action (a_date: DATE; a_locale_info: I18N_LOCALE_INFO): STRING_32 -- Returns the full month name -- associated to formatting character month_name require a_date_exists: a_date /= Void a_locale_info_exists: a_locale_info /= Void ensure result_exists: Result /= Void month_padded_action (a_date: DATE): STRING_32 -- Returns the month as a decimal number (range 01 to 12). -- associated to formatting character month_padded require a_date_exists: a_date /= Void ensure result_exists: Result /= Void week_number_iso_action (a_date: DATE): STRING_32 -- Returns the ISO 8601:1988 week number of the current year as a decimal number, -- range 01 to 53, where week 1 is the first -- associated to formatting character week_number_iso require a_date_exists: a_date /= Void ensure result_exists: Result /= Void week_number_monday_as_first_action (a_date: DATE): STRING_32 -- Not supported, result is the same as `week_number_sunday_as_first_action` -- associated to formatting character week_number_monday require a_date_exists: a_date /= Void ensure result_exists: Result /= Void week_number_sunday_as_first_action (a_date: DATE): STRING_32 -- Returns the week number of the current year as a decimal number, range 00 to 53, -- starting with the first Monday as the first day of week 01 -- associated to formatting character week_number_sunday require a_date_exists: a_date /= Void ensure result_exists: Result /= Void year_1_action (a_date: DATE): STRING_32 -- Year represented only by the last digit. -- associated to formatting character year_1 require a_date_exists: a_date /= Void ensure result_exists: Result /= Void correct_lenght: Result.count = 1 year_2_action (a_date: DATE): STRING_32 -- Returns the year as a decimal number without a century (range 00 to 99). -- associated to formatting character year_2 require a_date_exists: a_date /= Void ensure result_exists: Result /= Void correct_lenght: Result.count = 2 year_4_action (a_date: DATE): STRING_32 -- Returns the Year represented by full four or five digits, depending on the calendar used. -- associated to formatting character year_4 require a_date_exists: a_date /= Void ensure result_exists: Result /= 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 -- Shared object Fu: I18N_FORMATTING_UTILITY -- fu: formatting utility -- (from SHARED_I18N_FORMATTING_UTILITY) feature -- Time related actions am_pm_1_action (a_time: TIME): STRING_32 -- Returns one-character time marker string. (Am/pm -> a/p) -- associated to formatting character am_pm_1 require a_time_exists: a_time /= Void ensure result_exists: Result /= Void correct_result: (a_time.hour <= 12 implies Result.same_string_general ("a")) xor (a_time.hour > 12 implies Result.same_string_general ("p")) am_pm_lowercase_action (a_time: TIME; a_locale_info: I18N_LOCALE_INFO): STRING_32 -- Returns multi-character time marker string Lowercase -- associated to formatting character am_pm_lowercase require a_time_exists: a_time /= Void a_locale_info_exists: a_locale_info /= Void ensure result_exists: Result /= Void is_lower: Result.is_valid_as_string_8 implies Result.as_lower.is_equal (Result) am_pm_uppercase_action (a_time: TIME; a_locale_info: I18N_LOCALE_INFO): STRING_32 -- Returns multi-character time marker string (Uppercase) -- associated to formatting character am_pm_uppercase require a_time_exists: a_time /= Void a_locale_info_exists: a_locale_info /= Void ensure result_exists: Result /= Void is_upper: Result.is_valid_as_string_8 implies Result.as_upper.is_equal (Result) hour_12_action (a_time: TIME): STRING_32 -- Returns Hours without leading zeros -- for single-digit hours (12-hour clock). -- associated to formatting character hour_12 require a_time_exists: a_time /= Void ensure result_exists: Result /= Void hour_12_padded_action (a_time: TIME): STRING_32 -- Returns Hours with leading zeros for -- single-digit hours (12-hour clock). -- associated to formatting character hour_12_padded require a_time_exists: a_time /= Void ensure result_exists: Result /= Void hour_24_action (a_time: TIME): STRING_32 -- Returns Hours without leading zeros -- for single-digit hours (24-hour clock) -- associated to formatting character hour_24 require a_time_exists: a_time /= Void ensure result_exists: Result /= Void hour_24_padded_action (a_time: TIME): STRING_32 -- Returns Hours with leading zeros -- for single-digit hours (24-hour clock) -- associated to `' -- associated to formatting character hour_24_padded require a_time_exists: a_time /= Void ensure result_exists: Result /= Void minutes_action (a_time: TIME): STRING_32 -- Returns Minutes without leading -- zeros for single-digit minutes. -- associated to formatting character minutes require a_time_exists: a_time /= Void ensure result_exists: Result /= Void minutes_padded_action (a_time: TIME): STRING_32 -- Returns the minute as a decimal number -- with leading zeros for single-digit minutes. -- associated to formatting character minutes_padded require a_time_exists: a_time /= Void ensure result_exists: Result /= Void seconds_action (a_time: TIME): STRING_32 -- Returns seconds without leading zeros for single-digit seconds. -- associated to formatting character seconds require a_time_exists: a_time /= Void ensure result_exists: Result /= Void seconds_padded_action (a_time: TIME): STRING_32 -- Returns seconds with leading zeros for single-digit seconds. -- associated to formatting character seconds_padded require a_time_exists: a_time /= Void ensure result_exists: Result /= Void invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note library: "Internationalization library" copyright: "Copyright (c) 1984-2009, 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 I18N_FORMATTING_ACTIONS -- Generated by Eiffel Studio --
For more details: eiffel.org