ICU 49.1.1  49.1.1
datefmt.h
Go to the documentation of this file.
1 /*
2  ********************************************************************************
3  * Copyright (C) 1997-2012, International Business Machines
4  * Corporation and others. All Rights Reserved.
5  ********************************************************************************
6  *
7  * File DATEFMT.H
8  *
9  * Modification History:
10  *
11  * Date Name Description
12  * 02/19/97 aliu Converted from java.
13  * 04/01/97 aliu Added support for centuries.
14  * 07/23/98 stephen JDK 1.2 sync
15  * 11/15/99 weiv Added support for week of year/day of week formatting
16  ********************************************************************************
17  */
18 
19 #ifndef DATEFMT_H
20 #define DATEFMT_H
21 
22 #include "unicode/utypes.h"
23 
24 #if !UCONFIG_NO_FORMATTING
25 
26 #include "unicode/udat.h"
27 #include "unicode/calendar.h"
28 #include "unicode/numfmt.h"
29 #include "unicode/format.h"
30 #include "unicode/locid.h"
31 
38 
39 class TimeZone;
41 
138 class U_I18N_API DateFormat : public Format {
139 public:
140 
148  enum EStyle
149  {
150  kNone = -1,
151 
152  kFull = 0,
153  kLong = 1,
154  kMedium = 2,
155  kShort = 3,
156 
157  kDateOffset = kShort + 1,
158  // kFull + kDateOffset = 4
159  // kLong + kDateOffset = 5
160  // kMedium + kDateOffset = 6
161  // kShort + kDateOffset = 7
162 
163  kDateTime = 8,
164  // Default DateTime
165 
166  kDateTimeOffset = kDateTime + 1,
167  // kFull + kDateTimeOffset = 9
168  // kLong + kDateTimeOffset = 10
169  // kMedium + kDateTimeOffset = 11
170  // kShort + kDateTimeOffset = 12
171 
172  // relative dates
173  kRelative = (1 << 7),
174 
175  kFullRelative = (kFull | kRelative),
176 
177  kLongRelative = kLong | kRelative,
178 
179  kMediumRelative = kMedium | kRelative,
180 
181  kShortRelative = kShort | kRelative,
182 
183 
184  kDefault = kMedium,
185 
186 
187 
192  FULL = kFull,
193  LONG = kLong,
194  MEDIUM = kMedium,
195  SHORT = kShort,
196  DEFAULT = kDefault,
197  DATE_OFFSET = kDateOffset,
198  NONE = kNone,
199  DATE_TIME = kDateTime
200  };
201 
206  virtual ~DateFormat();
207 
212  virtual UBool operator==(const Format&) const;
213 
214 
215  using Format::format;
216 
231  virtual UnicodeString& format(const Formattable& obj,
232  UnicodeString& appendTo,
233  FieldPosition& pos,
234  UErrorCode& status) const;
235 
251  virtual UnicodeString& format(const Formattable& obj,
252  UnicodeString& appendTo,
253  FieldPositionIterator* posIter,
254  UErrorCode& status) const;
288  virtual UnicodeString& format( Calendar& cal,
289  UnicodeString& appendTo,
290  FieldPosition& fieldPosition) const = 0;
291 
310  virtual UnicodeString& format(Calendar& cal,
311  UnicodeString& appendTo,
312  FieldPositionIterator* posIter,
313  UErrorCode& status) const;
341  UnicodeString& format( UDate date,
342  UnicodeString& appendTo,
343  FieldPosition& fieldPosition) const;
344 
358  UnicodeString& format(UDate date,
359  UnicodeString& appendTo,
360  FieldPositionIterator* posIter,
361  UErrorCode& status) const;
373  UnicodeString& format(UDate date, UnicodeString& appendTo) const;
374 
385  UnicodeString& format(const Formattable& obj,
386  UnicodeString& appendTo,
387  UErrorCode& status) const;
388 
423  virtual UDate parse( const UnicodeString& text,
424  UErrorCode& status) const;
425 
452  virtual void parse( const UnicodeString& text,
453  Calendar& cal,
454  ParsePosition& pos) const = 0;
455 
486  UDate parse( const UnicodeString& text,
487  ParsePosition& pos) const;
488 
515  virtual void parseObject(const UnicodeString& source,
516  Formattable& result,
517  ParsePosition& parse_pos) const;
518 
526  static DateFormat* U_EXPORT2 createInstance(void);
527 
539  static DateFormat* U_EXPORT2 createTimeInstance(EStyle style = kDefault,
540  const Locale& aLocale = Locale::getDefault());
541 
557  static DateFormat* U_EXPORT2 createDateInstance(EStyle style = kDefault,
558  const Locale& aLocale = Locale::getDefault());
559 
578  static DateFormat* U_EXPORT2 createDateTimeInstance(EStyle dateStyle = kDefault,
579  EStyle timeStyle = kDefault,
580  const Locale& aLocale = Locale::getDefault());
581 
589  static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
590 
595  virtual UBool isLenient(void) const;
596 
607  virtual void setLenient(UBool lenient);
608 
614  virtual const Calendar* getCalendar(void) const;
615 
625  virtual void adoptCalendar(Calendar* calendarToAdopt);
626 
634  virtual void setCalendar(const Calendar& newCalendar);
635 
636 
643  virtual const NumberFormat* getNumberFormat(void) const;
644 
651  virtual void adoptNumberFormat(NumberFormat* formatToAdopt);
652 
658  virtual void setNumberFormat(const NumberFormat& newNumberFormat);
659 
665  virtual const TimeZone& getTimeZone(void) const;
666 
673  virtual void adoptTimeZone(TimeZone* zoneToAdopt);
674 
680  virtual void setTimeZone(const TimeZone& zone);
681 
682 protected:
689  DateFormat();
690 
695  DateFormat(const DateFormat&);
696 
702 
710 
718 
719 private:
728  static DateFormat* U_EXPORT2 create(EStyle timeStyle, EStyle dateStyle, const Locale& inLocale);
729 
730 public:
731 #ifndef U_HIDE_OBSOLETE_API
732 
737  enum EField
738  {
739  // Obsolete; use UDateFormatField instead
740  kEraField = UDAT_ERA_FIELD,
741  kYearField = UDAT_YEAR_FIELD,
742  kMonthField = UDAT_MONTH_FIELD,
743  kDateField = UDAT_DATE_FIELD,
744  kHourOfDay1Field = UDAT_HOUR_OF_DAY1_FIELD,
745  kHourOfDay0Field = UDAT_HOUR_OF_DAY0_FIELD,
746  kMinuteField = UDAT_MINUTE_FIELD,
747  kSecondField = UDAT_SECOND_FIELD,
748  kMillisecondField = UDAT_FRACTIONAL_SECOND_FIELD,
749  kDayOfWeekField = UDAT_DAY_OF_WEEK_FIELD,
750  kDayOfYearField = UDAT_DAY_OF_YEAR_FIELD,
751  kDayOfWeekInMonthField = UDAT_DAY_OF_WEEK_IN_MONTH_FIELD,
752  kWeekOfYearField = UDAT_WEEK_OF_YEAR_FIELD,
753  kWeekOfMonthField = UDAT_WEEK_OF_MONTH_FIELD,
754  kAmPmField = UDAT_AM_PM_FIELD,
755  kHour1Field = UDAT_HOUR1_FIELD,
756  kHour0Field = UDAT_HOUR0_FIELD,
757  kTimezoneField = UDAT_TIMEZONE_FIELD,
758  kYearWOYField = UDAT_YEAR_WOY_FIELD,
759  kDOWLocalField = UDAT_DOW_LOCAL_FIELD,
760  kExtendedYearField = UDAT_EXTENDED_YEAR_FIELD,
761  kJulianDayField = UDAT_JULIAN_DAY_FIELD,
762  kMillisecondsInDayField = UDAT_MILLISECONDS_IN_DAY_FIELD,
763 
764  // Obsolete; use UDateFormatField instead
765  ERA_FIELD = UDAT_ERA_FIELD,
766  YEAR_FIELD = UDAT_YEAR_FIELD,
767  MONTH_FIELD = UDAT_MONTH_FIELD,
768  DATE_FIELD = UDAT_DATE_FIELD,
769  HOUR_OF_DAY1_FIELD = UDAT_HOUR_OF_DAY1_FIELD,
770  HOUR_OF_DAY0_FIELD = UDAT_HOUR_OF_DAY0_FIELD,
771  MINUTE_FIELD = UDAT_MINUTE_FIELD,
772  SECOND_FIELD = UDAT_SECOND_FIELD,
773  MILLISECOND_FIELD = UDAT_FRACTIONAL_SECOND_FIELD,
774  DAY_OF_WEEK_FIELD = UDAT_DAY_OF_WEEK_FIELD,
775  DAY_OF_YEAR_FIELD = UDAT_DAY_OF_YEAR_FIELD,
776  DAY_OF_WEEK_IN_MONTH_FIELD = UDAT_DAY_OF_WEEK_IN_MONTH_FIELD,
777  WEEK_OF_YEAR_FIELD = UDAT_WEEK_OF_YEAR_FIELD,
778  WEEK_OF_MONTH_FIELD = UDAT_WEEK_OF_MONTH_FIELD,
779  AM_PM_FIELD = UDAT_AM_PM_FIELD,
780  HOUR1_FIELD = UDAT_HOUR1_FIELD,
781  HOUR0_FIELD = UDAT_HOUR0_FIELD,
782  TIMEZONE_FIELD = UDAT_TIMEZONE_FIELD
783  };
784 #endif /* U_HIDE_OBSOLETE_API */
785 };
786 
787 inline UnicodeString&
789  UnicodeString& appendTo,
790  UErrorCode& status) const {
791  return Format::format(obj, appendTo, status);
792 }
794 
795 #endif /* #if !UCONFIG_NO_FORMATTING */
796 
797 #endif // _DATEFMT
798 //eof