Movatterモバイル変換

Construct aSimpleDateFormat using the default pattern for the default locale.

[Note:] Not all locales supportSimpleDateFormat; for full generality, use the factory methods in theDateFormat class.

Parameters

status

Output param set to success/failure code.

Stable:

ICU 2.0

Construct aSimpleDateFormat using the given pattern and the default locale.

The locale is used to obtain the symbols used in formatting (e.g., the names of the months), but not to provide the pattern.

[Note:] Not all locales supportSimpleDateFormat; for full generality, use the factory methods in theDateFormat class.

Parameters

pattern	the pattern for the format.
status	Output param set to success/failure code.

Stable:

ICU 2.0

Construct aSimpleDateFormat using the given pattern, numbering system override, and the default locale.

The locale is used to obtain the symbols used in formatting (e.g., the names of the months), but not to provide the pattern.

A numbering system override is a string containing either the name of a known numbering system, or a set of field and numbering system pairs that specify which fields are to be formatted with the alternate numbering system. For example, to specify that all numeric fields in the specified date or time pattern are to be rendered using Thai digits, simply specify the numbering system override as "thai". To specify that just the year portion of the date be formatted using Hebrew numbering, use the override string "y=hebrew". Numbering system overrides can be combined using a semi-colon character in the override string, such as "d=decimal;M=arabic;y=hebrew", etc.

[Note:] Not all locales supportSimpleDateFormat; for full generality, use the factory methods in theDateFormat class.

Parameters

pattern	the pattern for the format.
override	the override string.
status	Output param set to success/failure code.

Stable:

ICU 4.2

Construct aSimpleDateFormat using the given pattern and locale.

The locale is used to obtain the symbols used in formatting (e.g., the names of the months), but not to provide the pattern.

[Note:] Not all locales supportSimpleDateFormat; for full generality, use the factory methods in theDateFormat class.

Parameters

pattern	the pattern for the format.
locale	the given locale.
status	Output param set to success/failure code.

Stable:

ICU 2.0

Construct aSimpleDateFormat using the given pattern, numbering system override, and locale.

The locale is used to obtain the symbols used in formatting (e.g., the names of the months), but not to provide the pattern.

A numbering system override is a string containing either the name of a known numbering system, or a set of field and numbering system pairs that specify which fields are to be formatted with the alternate numbering system. For example, to specify that all numeric fields in the specified date or time pattern are to be rendered using Thai digits, simply specify the numbering system override as "thai". To specify that just the year portion of the date be formatted using Hebrew numbering, use the override string "y=hebrew". Numbering system overrides can be combined using a semi-colon character in the override string, such as "d=decimal;M=arabic;y=hebrew", etc.

[Note:] Not all locales supportSimpleDateFormat; for full generality, use the factory methods in theDateFormat class.

Parameters

pattern	the pattern for the format.
override	the numbering system override.
locale	the given locale.
status	Output param set to success/failure code.

Stable:

ICU 4.2

Construct aSimpleDateFormat using the given pattern and locale-specific symbol data.

The formatter takes ownership of theDateFormatSymbols object; the caller is no longer responsible for deleting it.

Parameters

pattern	the given pattern for the format.
formatDataToAdopt	the symbols to be adopted.
status	Output param set to success/faulure code.

Stable:

ICU 2.0

Construct aSimpleDateFormat using the given pattern and locale-specific symbol data.

TheDateFormatSymbols object is NOT adopted; the caller remains responsible for deleting it.

Parameters

pattern	the given pattern for the format.
formatData	the formatting symbols to be use.
status	Output param set to success/faulure code.

Stable:

ICU 2.0

Copy constructor.

Stable:

ICU 2.0

Destructor.

Stable:

ICU 2.0

Set the calendar to be used by this date format.

Initially, the default calendar for the specified or default locale is used. The caller should not delete theCalendar object after it is adopted by this call. Adopting a new calendar will change to the default symbols.

Parameters

calendarToAdopt

Calendar object to be adopted.

Stable:

ICU 2.0

Reimplemented fromicu::DateFormat.

Set the date/time formatting symbols.

The caller no longer owns theDateFormatSymbols object and should not delete it after making this call.

Parameters

newFormatSymbols

the given date-time formatting symbols to copy.

Stable:

ICU 2.0

Allow the user to set theNumberFormat for several fields It can be a single field like: "y"(year) or "M"(month) It can be several field combined together: "yM"(year and month) Note: 1 symbol field is enough for multiple symbol field (so "y" will override "yy", "yyy") If the field is not numeric, then override has no effect (like "MMM" will use abbreviation, not numerical field) Per fieldNumberFormat can also be cleared in {.

See also

DateFormat::setNumberFormat(const NumberFormat& newNumberFormat)}

Parameters

fields	the fields to override(like y)
formatToAdopt	the NumbeferFormat used
status	Receives a status code, which will be U_ZERO_ERROR if the operation succeeds.

Stable:

ICU 54

Overrides base class method and This method clears per fieldNumberFormat instances previously set by {.

See also

adoptNumberFormat(const UnicodeString&, NumberFormat*, UErrorCode)}

Parameters

formatToAdopt

the NumbeferFormat used

Stable:

ICU 54

Reimplemented fromicu::DateFormat.

Sets theTimeZoneFormat to be used by this date/time formatter.

The caller should not delete theTimeZoneFormat object after it is adopted by this call.

Parameters

timeZoneFormatToAdopt

TheTimeZoneFormat object to be adopted.

Internal:

Do not use. This API is for internal use only. ICU 49 technology preview

Apply the given localized pattern string to this date format.

(seetoLocalizedPattern() for more information on localized patterns.)

Parameters

pattern	The localized pattern to be applied.
status	Output param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result.

Stable:

ICU 2.0

Apply the given unlocalized pattern string to this date format.

(i.e., after this call, this formatter will format dates according to the new pattern)

Parameters

pattern

The pattern to be applied.

Stable:

ICU 2.0

Clone thisFormat object polymorphically.

The caller owns the result and should delete it when done.

Returns

A copy of the object.

Stable:

ICU 2.0

Implementsicu::DateFormat.

Formats a date into a date/time string.

This is an abstract method which concrete subclasses must implement.

On input, theFieldPosition parameter may have its "field" member filled with an enum value specifying a field. On output, theFieldPosition will be filled in with the text offsets for that field.

For example, given a time text "1996.07.10 AD at 15:08:56 PDT", if the given fieldPosition.field is UDAT_YEAR_FIELD, the offsets fieldPosition.beginIndex and statfieldPositionus.getEndIndex will be set to 0 and 4, respectively.

Notice that if the same time field appears more than once in a pattern, the status will be set for the first occurrence of that time field. For instance, formatting a UDate to the time string "1 PM PDT (Pacific Daylight Time)" using the pattern "h a z (zzzz)" and the alignment field DateFormat::TIMEZONE_FIELD, the offsets fieldPosition.beginIndex and fieldPosition.getEndIndex will be set to 5 and 8, respectively, for the first occurrence of the timezone pattern character 'z'.

Parameters

cal	Calendar set to the date and time to be formatted into a date/time string. When the calendar type is different from the internal calendar held by thisDateFormat instance, the date and the time zone will be inherited from the input calendar, but other calendar field values will be calculated by the internal calendar.
appendTo	Output parameter to receive result. Result is appended to existing contents.
fieldPosition	On input: an alignment field, if desired (see examples above) On output: the offsets of the alignment field (see examples above)

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.1

Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970.

OverridesDateFormat pure virtual method.

Example: using the US locale: "yyyy.MM.dd e 'at' HH:mm:ss zzz" ->> 1996.07.10 AD at 15:08:56 PDT

Parameters

cal	Calendar set to the date and time to be formatted into a date/time string.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	The formatting position. On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.1

Implementsicu::DateFormat.

Formats a date into a date/time string.

Subclasses should implement this method.

Parameters

cal	Calendar set to the date and time to be formatted into a date/time string. When the calendar type is different from the internal calendar held by thisDateFormat instance, the date and the time zone will be inherited from the input calendar, but other calendar field values will be calculated by the internal calendar.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Field values are defined in UDateFormatField. Can be nullptr.
status	error status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970.

OverridesDateFormat pure virtual method.

Example: using the US locale: "yyyy.MM.dd e 'at' HH:mm:ss zzz" ->> 1996.07.10 AD at 15:08:56 PDT

Parameters

cal	Calendar set to the date and time to be formatted into a date/time string.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Field values are defined in UDateFormatField.
status	Input/output param set to success/failure code.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Reimplemented fromicu::DateFormat.

Format an object to produce a string.

This is a pure virtual method which subclasses must implement. This method allows polymorphic formatting ofFormattable objects. If a subclass ofFormat receives aFormattable object type it doesn't handle (e.g., if a numericFormattable is passed to aDateFormat object) then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format an object to produce a string.

This method handlesFormattable objects with a UDate type. If a theFormattable object type is not a Date, then it returns a failing UErrorCode.

Parameters

obj	The object to format. Must be a Date.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format an object to produce a string.

Subclasses should override this method. This method allows polymorphic formatting ofFormattable objects. If a subclass ofFormat receives aFormattable object type it doesn't handle (e.g., if a numericFormattable is passed to aDateFormat object) then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Format an object to produce a string.

This method handlesFormattable objects with a UDate type. If a theFormattable object type is not a Date, then it returns a failing UErrorCode.

Parameters

obj	The object to format. Must be a Date.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Field values are defined in UDateFormatField. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Formats an object to produce a string.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
status	Output parameter filled in with success or failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Formats a UDate into a date/time string.

If there is a problem, you won't know, using this method. Use the overloadedformat() method which takes aFieldPosition& to detect formatting problems.

Parameters

date	The UDate value to be formatted into a string.
appendTo	Output parameter to receive result. Result is appended to existing contents.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Formats a UDate into a date/time string.

On input, theFieldPosition parameter may have its "field" member filled with an enum value specifying a field. On output, theFieldPosition will be filled in with the text offsets for that field.

For example, given a time text "1996.07.10 AD at 15:08:56 PDT", if the given fieldPosition.field is UDAT_YEAR_FIELD, the offsets fieldPosition.beginIndex and statfieldPositionus.getEndIndex will be set to 0 and 4, respectively.

Notice that if the same time field appears more than once in a pattern, the status will be set for the first occurrence of that time field. For instance, formatting a UDate to the time string "1 PM PDT (Pacific Daylight Time)" using the pattern "h a z (zzzz)" and the alignment field DateFormat::TIMEZONE_FIELD, the offsets fieldPosition.beginIndex and fieldPosition.getEndIndex will be set to 5 and 8, respectively, for the first occurrence of the timezone pattern character 'z'.

Parameters

date	UDate to be formatted into a date/time string.
appendTo	Output parameter to receive result. Result is appended to existing contents.
fieldPosition	On input: an alignment field, if desired (see examples above) On output: the offsets of the alignment field (see examples above)

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Formats a UDate into a date/time string.

Parameters

date	UDate to be formatted into a date/time string.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Field values are defined in UDateFormatField. Can be nullptr.
status	error status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Get the start UDate used to interpret two-digit year strings.

When dates are parsed having 2-digit year strings, they are placed within a assumed range of 100 years starting on the two digit start date. For example, the string "24-Jan-17" may be in the year 1817, 1917, 2017, or some other year.SimpleDateFormat chooses a year so that the resultant date is on or after the two digit start date and within 100 years of the two digit start date.

By default, the two digit start date is set to 80 years before the current time at which aSimpleDateFormat object is created.

Parameters

status

Filled in with U_ZERO_ERROR if the parse was successful, and with an error value if there was a parse error.

Stable:

ICU 2.0

Definition at line1313 of filesmpdtfmt.h.

Gets the date/time formatting symbols (this is an object carrying the various strings and other symbols used in formatting: e.g., month names and abbreviations, time zone names, AM/PM strings, etc.)

Returns

a copy of the date-time formatting data associated with this date-time formatter.

Stable:

ICU 2.0

Returns a unique class ID POLYMORPHICALLY.

Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphicoperator==() andclone() methods call this method.

Returns

The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.

Stable:

ICU 2.0

Reimplemented fromicu::UObject.

Get the numbering system to be used for a particular field.

Parameters

field

The UDateFormatField to get

Stable:

ICU 54

This is for ICU internal use only.

Please do not use. Get the locale of this simple date formatter. It is used inDateIntervalFormat.

Returns

locale in this simple date formatter

Internal:

Do not use. This API is for internal use only. ICU 4.0

Return the class ID for this class.

This is useful only for comparing to a return value fromgetDynamicClassID(). For example:

.   Base* polymorphic_pointer = createPolymorphicObject();.   if (polymorphic_pointer->getDynamicClassID() ==.       erived::getStaticClassID()) ...

Returns

The class ID for all objects of this class.

Stable:

ICU 2.0

Gets the time zone format object associated with this date/time formatter.

Returns

the time zone format associated with this date/time formatter.

Internal:

Do not use. This API is for internal use only. ICU 49 technology preview

This is for ICU internal use only.

Please do not use. Check whether the 'field' is smaller than all the fields covered in pattern, return true if it is. The sequence of calendar field, from large to small is: ERA, YEAR, MONTH, DATE, AM_PM, HOUR, MINUTE,...

Parameters

pattern	the pattern to check against
field	the calendar field need to check against

Returns

true if the 'field' is smaller than all the fields covered in pattern. false otherwise.

Internal:

Do not use. This API is for internal use only. ICU 4.0

This is for ICU internal use only.

Please do not use. Check whether the 'field' is smaller than all the fields covered in pattern, return true if it is. The sequence of calendar field, from large to small is: ERA, YEAR, MONTH, DATE, AM_PM, HOUR, MINUTE,...

Parameters

field

the calendar field need to check against

Returns

true if the 'field' is smaller than all the fields covered in pattern. false otherwise.

Internal:

Do not use. This API is for internal use only. ICU 4.0

Assignment operator.

Stable:

ICU 2.0

Return true if the givenFormat objects are semantically equal.

Objects of different subclasses are considered unequal.

Parameters

other

the object to be compared with.

Returns

true if the givenFormat objects are semantically equal.

Stable:

ICU 2.0

Reimplemented fromicu::DateFormat.

Parse a date/time string beginning at the given parse position.

For example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date that is equivalent to Date(837039928046).

By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false).

See also

DateFormat::setLenient(boolean)

Parameters

text	The date/time string to be parsed
cal	ACalendar set on input to the date and time to be used for missing values in the date/time string being parsed, and set on output to the parsed date/time. When the calendar type is different from the internal calendar held by thisSimpleDateFormat instance, the internal calendar will be cloned to a work calendar set to the same milliseconds and time zone as the cal parameter, field values will be parsed based on the work calendar, then the result (milliseconds and time zone) will be set in this calendar.
pos	On input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.

Stable:

ICU 2.1

Implementsicu::DateFormat.

Parse a date/time string beginning at the given parse position.

For example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date that is equivalent to Date(837039928046).

By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false).

See also

DateFormat::setLenient(boolean)

Parameters

text	The date/time string to be parsed.
cal	ACalendar set on input to the date and time to be used for missing values in the date/time string being parsed, and set on output to the parsed date/time. When the calendar type is different from the internal calendar held by thisDateFormat instance, the internal calendar will be cloned to a work calendar set to the same milliseconds and time zone as the cal parameter, field values will be parsed based on the work calendar, then the result (milliseconds and time zone) will be set in this calendar.
pos	On input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.

Stable:

ICU 2.1

Parse a date/time string beginning at the given parse position.

For example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date that is equivalent to Date(837039928046).

By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false).

See also

DateFormat::setLenient(boolean)

Note that the normal date formats associated with some calendars - such as the Chinese lunar calendar - do not specify enough fields to enable dates to be parsed unambiguously. In the case of the Chinese lunar calendar, while the year within the current 60-year cycle is specified, the number of such cycles since the start date of the calendar (in the ERA field of theCalendar object) is not normally part of the format, and parsing may assume the wrong era. For cases such as this it is recommended that clients parse using the method parse(const UnicodeString&, Calendar& cal, ParsePosition&) with theCalendar passed in set to the current date, or to a date within the era/cycle that should be assumed if absent in the format.

Parameters

text	The date/time string to be parsed into a UDate value.
pos	On input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.

Returns

A valid UDate if the input could be parsed.

Stable:

ICU 2.0

Parse a date/time string.

For example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a UDate that is equivalent to Date(837039928046). Parsing begins at the beginning of the string and proceeds as far as possible. Assuming no parse errors were encountered, this function doesn't return any information about how much of the string was consumed by the parsing. If you need that information, use the version ofparse() that takes aParsePosition.

By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false).

See also

DateFormat::setLenient(boolean)

Note that the normal date formats associated with some calendars - such as the Chinese lunar calendar - do not specify enough fields to enable dates to be parsed unambiguously. In the case of the Chinese lunar calendar, while the year within the current 60-year cycle is specified, the number of such cycles since the start date of the calendar (in the ERA field of theCalendar object) is not normally part of the format, and parsing may assume the wrong era. For cases such as this it is recommended that clients parse using the method parse(const UnicodeString&, Calendar& cal, ParsePosition&) with theCalendar passed in set to the current date, or to a date within the era/cycle that should be assumed if absent in the format.

Parameters

text	The date/time string to be parsed into a UDate value.
status	Output param to be set to success/failure code. If 'text' cannot be parsed, it will be set to a failure code.

Returns

The parsed UDate value, if successful.

Stable:

ICU 2.0

Set the start UDate used to interpret two-digit year strings.

When dates are parsed having 2-digit year strings, they are placed within a assumed range of 100 years starting on the two digit start date. For example, the string "24-Jan-17" may be in the year 1817, 1917, 2017, or some other year.SimpleDateFormat chooses a year so that the resultant date is on or after the two digit start date and within 100 years of the two digit start date.

By default, the two digit start date is set to 80 years before the current time at which aSimpleDateFormat object is created.

Parameters

d	start UDate used to interpret two-digit year strings.
status	Filled in with U_ZERO_ERROR if the parse was successful, and with an error value if there was a parse error.

Stable:

ICU 2.0

Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE.

Note: For getContext, seeDateFormat.

Parameters

value	The UDisplayContext value to set.
status	Input/output status. If at entry this indicates a failure status, the function will do nothing; otherwise this will be updated with any new status from the function.

Stable:

ICU 53

Reimplemented fromicu::DateFormat.

Set the date/time formatting data.

Parameters

newFormatSymbols

the given date-time formatting symbols to copy.

Stable:

ICU 2.0

Sets theTimeZoneFormat to be used by this date/time formatter.

Parameters

newTimeZoneFormat

TheTimeZoneFormat object to copy.

Internal:

Do not use. This API is for internal use only. ICU 49 technology preview

Return a localized pattern string describing this date format.

In most cases, this will return the same thing astoPattern(), but a locale can specify characters to use in pattern descriptions in place of the ones described in this class's class documentation. (Presumably, letters that would be more mnemonic in that locale's language.) This function would produce a pattern using those letters.

Note: This implementation depends onDateFormatSymbols::getLocalPatternChars() to get localized format pattern characters. ICU does not include localized pattern character data, therefore, unless user sets localized pattern characters manually, this method returns the same result astoPattern().

Parameters

result	Receives the localized pattern.
status	Output param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result.

Returns

A reference to 'result'.

Stable:

ICU 2.0

Return a pattern string describing this date format.

Parameters

result

Output param to receive the pattern.

Returns

A reference to 'result'.

Stable:

ICU 2.0