// © 2016 and later: Unicode, Inc. and others. // License & terms of use: http://www.unicode.org/copyright.html /* ******************************************************************************** * Copyright (C) 1997-2011, International Business Machines Corporation and others. * All Rights Reserved. ******************************************************************************** * * File FORMAT.H * * Modification History: * * Date Name Description * 02/19/97 aliu Converted from java. * 03/17/97 clhuang Updated per C++ implementation. * 03/27/97 helena Updated to pass the simple test after code review. ******************************************************************************** */ // ***************************************************************************** // This file was generated from the java source file Format.java // ***************************************************************************** #ifndef FORMAT_H #define FORMAT_H #include "unicode/utypes.h" #if U_SHOW_CPLUSPLUS_API /** * \file * \brief C++ API: Base class for all formats. */ #if !UCONFIG_NO_FORMATTING #include "unicode/unistr.h" #include "unicode/fmtable.h" #include "unicode/fieldpos.h" #include "unicode/fpositer.h" #include "unicode/parsepos.h" #include "unicode/parseerr.h" #include "unicode/locid.h" U_NAMESPACE_BEGIN /** * Base class for all formats. This is an abstract base class which * specifies the protocol for classes which convert other objects or * values, such as numeric values and dates, and their string * representations. In some cases these representations may be * localized or contain localized characters or strings. For example, * a numeric formatter such as DecimalFormat may convert a numeric * value such as 12345 to the string "$12,345". It may also parse * the string back into a numeric value. A date and time formatter * like SimpleDateFormat may represent a specific date, encoded * numerically, as a string such as "Wednesday, February 26, 1997 AD". * <P> * Many of the concrete subclasses of Format employ the notion of * a pattern. A pattern is a string representation of the rules which * govern the interconversion between values and strings. For example, * a DecimalFormat object may be associated with the pattern * "$#,##0.00;($#,##0.00)", which is a common US English format for * currency values, yielding strings such as "$1,234.45" for 1234.45, * and "($987.65)" for 987.6543. The specific syntax of a pattern * is defined by each subclass. * <P> * Even though many subclasses use patterns, the notion of a pattern * is not inherent to Format classes in general, and is not part of * the explicit base class protocol. * <P> * Two complex formatting classes bear mentioning. These are * MessageFormat and ChoiceFormat. ChoiceFormat is a subclass of * NumberFormat which allows the user to format different number ranges * as strings. For instance, 0 may be represented as "no files", 1 as * "one file", and any number greater than 1 as "many files". * MessageFormat is a formatter which utilizes other Format objects to * format a string containing with multiple values. For instance, * A MessageFormat object might produce the string "There are no files * on the disk MyDisk on February 27, 1997." given the arguments 0, * "MyDisk", and the date value of 2/27/97. See the ChoiceFormat * and MessageFormat headers for further information. * <P> * If formatting is unsuccessful, a failing UErrorCode is returned when * the Format cannot format the type of object, otherwise if there is * something illformed about the the Unicode replacement character * 0xFFFD is returned. * <P> * If there is no match when parsing, a parse failure UErrorCode is * returned for methods which take no ParsePosition. For the method * that takes a ParsePosition, the index parameter is left unchanged. * <P> * <em>User subclasses are not supported.</em> While clients may write * subclasses, such code will not necessarily work and will not be * guaranteed to work stably from release to release. */ class U_I18N_API Format : public UObject { … }; U_NAMESPACE_END #endif /* #if !UCONFIG_NO_FORMATTING */ #endif /* U_SHOW_CPLUSPLUS_API */ #endif // _FORMAT //eof