Main Page   Class Hierarchy   Alphabetical List   Data Structures   File List   Data Fields   Globals  

Formattable Class Reference

Formattable objects can be passed to the Format class or its subclasses for formatting. More...

#include <fmtable.h>


Public Types

enum  ISDATE { kIsDate }
 This enum is only used to let callers distinguish between the Formattable(UDate) constructor and the Formattable(double) constructor; the compiler cannot distinguish the signatures, since UDate is currently typedefed to be either double or long. More...

enum  Type {
  kDate, kDouble, kLong, kString,
  kArray
}
 The list of possible data types of this Formattable object.


Public Methods

 Formattable ()
 Formattable (UDate d, ISDATE)
 Creates a Formattable object with a UDate instance. More...

 Formattable (double d)
 Creates a Formattable object with a double number. More...

 Formattable (int32_t l)
 Creates a Formattable object with a long number. More...

 Formattable (const char *strToCopy)
 Creates a Formattable object with a char string pointer. More...

 Formattable (const UnicodeString &stringToCopy)
 Creates a Formattable object with a UnicodeString object to copy from. More...

 Formattable (UnicodeString *stringToAdopt)
 Creates a Formattable object with a UnicodeString object to adopt from. More...

 Formattable (const Formattable *arrayToCopy, int32_t count)
 Creates a Formattable object with an array of Formattable objects. More...

 Formattable (const Formattable &)
 Copy constructor. More...

Formattable & operator= (const Formattable &)
 Assignment operator. More...

UBool operator== (const Formattable &) const
 Equality comparison. More...

UBool operator!= (const Formattable &other) const
virtual ~Formattable ()
 Destructor. More...

Type getType (void) const
 Gets the data type of this Formattable object. More...

double getDouble (void) const
 Gets the double value of this object. More...

int32_t getLong (void) const
 Gets the long value of this object. More...

UDate getDate (void) const
 Gets the Date value of this object. More...

UnicodeStringgetString (UnicodeString &result) const
 Gets the string value of this object. More...

const UnicodeStringgetString (void) const
 Gets a const reference to the string value of this object. More...

UnicodeStringgetString (void)
 Gets a reference to the string value of this object. More...

const Formattable * getArray (int32_t &count) const
 Gets the array value and count of this object. More...

Formattable & operator[] (int32_t index)
 Accesses the specified element in the array value of this Formattable object. More...

void setDouble (double d)
 Sets the double value of this object. More...

void setLong (int32_t l)
 Sets the long value of this object. More...

void setDate (UDate d)
 Sets the Date value of this object. More...

void setString (const UnicodeString &stringToCopy)
 Sets the string value of this object. More...

void setArray (const Formattable *array, int32_t count)
 Sets the array value and count of this object. More...

void adoptString (UnicodeString *stringToAdopt)
 Sets and adopts the string value and count of this object. More...

void adoptArray (Formattable *array, int32_t count)
 Sets and adopts the array value and count of this object. More...


Detailed Description

Formattable objects can be passed to the Format class or its subclasses for formatting.

Formattable is a thin wrapper class which interconverts between the primitive numeric types (double, long, etc.) as well as UDate and UnicodeString.

Note that this is fundamentally different from the Java behavior, since in this case the various formattable objects do not occupy a hierarchy, but are all wrapped within this one class. Formattable encapsulates all the polymorphism in itself.

It would be easy to change this so that Formattable was an abstract base class of a genuine hierarchy, and that would clean up the code that currently must explicitly check for type, but that seems like overkill at this point.


Member Enumeration Documentation

enum Formattable::ISDATE
 

This enum is only used to let callers distinguish between the Formattable(UDate) constructor and the Formattable(double) constructor; the compiler cannot distinguish the signatures, since UDate is currently typedefed to be either double or long.

If UDate is changed later to be a bonafide class or struct, then we no longer need this enum.


Constructor & Destructor Documentation

Formattable::Formattable UDate    d,
ISDATE   
 

Creates a Formattable object with a UDate instance.

Parameters:
d  the UDate instance.
ISDATE  the flag to indicate this is a date. @stable

Formattable::Formattable double    d
 

Creates a Formattable object with a double number.

Parameters:
d  the double number. @stable

Formattable::Formattable int32_t    l
 

Creates a Formattable object with a long number.

Parameters:
d  the long number. @stable

Formattable::Formattable const char *    strToCopy
 

Creates a Formattable object with a char string pointer.

Assumes that the char string is null terminated.

Parameters:
strToCopy  the char string. @stable

Formattable::Formattable const UnicodeString   stringToCopy
 

Creates a Formattable object with a UnicodeString object to copy from.

Parameters:
strToCopy  the UnicodeString string. @stable

Formattable::Formattable UnicodeString   stringToAdopt
 

Creates a Formattable object with a UnicodeString object to adopt from.

Parameters:
strToAdopt  the UnicodeString string. @stable

Formattable::Formattable const Formattable *    arrayToCopy,
int32_t    count
 

Creates a Formattable object with an array of Formattable objects.

Parameters:
arrayToCopy  the Formattable object array.
count  the array count. @stable

Formattable::Formattable const Formattable &   
 

Copy constructor.

@stable

virtual Formattable::~Formattable   [virtual]
 

Destructor.

@stable


Member Function Documentation

void Formattable::adoptArray Formattable *    array,
int32_t    count
 

Sets and adopts the array value and count of this object.

@stable

void Formattable::adoptString UnicodeString   stringToAdopt
 

Sets and adopts the string value and count of this object.

@stable

const Formattable* Formattable::getArray int32_t &    count const [inline]
 

Gets the array value and count of this object.

@stable

UDate Formattable::getDate void    const [inline]
 

Gets the Date value of this object.

@stable

double Formattable::getDouble void    const [inline]
 

Gets the double value of this object.

@stable

int32_t Formattable::getLong void    const [inline]
 

Gets the long value of this object.

@stable

UnicodeString & Formattable::getString void    [inline]
 

Gets a reference to the string value of this object.

@draft

const UnicodeString & Formattable::getString void    const [inline]
 

Gets a const reference to the string value of this object.

@draft

UnicodeString& Formattable::getString UnicodeString   result const [inline]
 

Gets the string value of this object.

@stable

Type Formattable::getType void    const
 

Gets the data type of this Formattable object.

@stable

Formattable& Formattable::operator= const Formattable &   
 

Assignment operator.

@stable

UBool Formattable::operator== const Formattable &    const
 

Equality comparison.

@stable

Formattable& Formattable::operator[] int32_t    index [inline]
 

Accesses the specified element in the array value of this Formattable object.

Parameters:
index  the specified index.
Returns:
the accessed element in the array. @stable

void Formattable::setArray const Formattable *    array,
int32_t    count
 

Sets the array value and count of this object.

@stable

void Formattable::setDate UDate    d
 

Sets the Date value of this object.

@stable

void Formattable::setDouble double    d
 

Sets the double value of this object.

@stable

void Formattable::setLong int32_t    l
 

Sets the long value of this object.

@stable

void Formattable::setString const UnicodeString   stringToCopy
 

Sets the string value of this object.

@stable


The documentation for this class was generated from the following file:
Generated on Tue Mar 5 13:05:55 2002 for ICU 2.0 by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002