Main Page | Class Hierarchy | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

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 Member Functions

 Formattable (UDate d, ISDATE)
 Creates a Formattable object with a UDate instance.
 Formattable (double d)
 Creates a Formattable object with a double number.
 Formattable (int32_t l)
 Creates a Formattable object with a long number.
 Formattable (const char *strToCopy)
 Creates a Formattable object with a char string pointer.
 Formattable (const UnicodeString &stringToCopy)
 Creates a Formattable object with a UnicodeString object to copy from.
 Formattable (UnicodeString *stringToAdopt)
 Creates a Formattable object with a UnicodeString object to adopt from.
 Formattable (const Formattable *arrayToCopy, int32_t count)
 Creates a Formattable object with an array of Formattable objects.
 Formattable (const Formattable &)
 Copy constructor.
Formattableoperator= (const Formattable &)
 Assignment operator.
UBool operator== (const Formattable &) const
 Equality comparison.
UBool operator!= (const Formattable &other) const
virtual ~Formattable ()
 Destructor.
Type getType (void) const
 Gets the data type of this Formattable object.
double getDouble (void) const
 Gets the double value of this object.
int32_t getLong (void) const
 Gets the long value of this object.
UDate getDate (void) const
 Gets the Date value of this object.
UnicodeStringgetString (UnicodeString &result) const
 Gets the string value of this object.
const UnicodeStringgetString (void) const
 Gets a const reference to the string value of this object.
UnicodeStringgetString (void)
 Gets a reference to the string value of this object.
const FormattablegetArray (int32_t &count) const
 Gets the array value and count of this object.
Formattableoperator[] (int32_t index)
 Accesses the specified element in the array value of this Formattable object.
void setDouble (double d)
 Sets the double value of this object.
void setLong (int32_t l)
 Sets the long value of this object.
void setDate (UDate d)
 Sets the Date value of this object.
void setString (const UnicodeString &stringToCopy)
 Sets the string value of this object.
void setArray (const Formattable *array, int32_t count)
 Sets the array value and count of this object.
void adoptString (UnicodeString *stringToAdopt)
 Sets and adopts the string value and count of this object.
void adoptArray (Formattable *array, int32_t count)
 Sets and adopts the array value and count of this object.


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.

Formattable::Formattable double  d  ) 
 

Creates a Formattable object with a double number.

Parameters:
d the double number.

Formattable::Formattable int32_t  l  ) 
 

Creates a Formattable object with a long number.

Parameters:
d the long number.

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.

Formattable::Formattable const UnicodeString stringToCopy  ) 
 

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

Parameters:
strToCopy the UnicodeString string.

Formattable::Formattable UnicodeString stringToAdopt  ) 
 

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

Parameters:
strToAdopt the UnicodeString string.

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.

Formattable::Formattable const Formattable  ) 
 

Copy constructor.

virtual Formattable::~Formattable  )  [virtual]
 

Destructor.


Member Function Documentation

void Formattable::adoptArray Formattable array,
int32_t  count
 

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

void Formattable::adoptString UnicodeString stringToAdopt  ) 
 

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

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

Gets the array value and count of this object.

UDate Formattable::getDate void   )  const [inline]
 

Gets the Date value of this object.

double Formattable::getDouble void   )  const [inline]
 

Gets the double value of this object.

int32_t Formattable::getLong void   )  const [inline]
 

Gets the long value of this object.

UnicodeString & Formattable::getString void   )  [inline]
 

Gets a reference to the string value of this object.

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

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

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

Gets the string value of this object.

Type Formattable::getType void   )  const
 

Gets the data type of this Formattable object.

Formattable& Formattable::operator= const Formattable  ) 
 

Assignment operator.

UBool Formattable::operator== const Formattable  )  const
 

Equality comparison.

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.

void Formattable::setArray const Formattable array,
int32_t  count
 

Sets the array value and count of this object.

void Formattable::setDate UDate  d  ) 
 

Sets the Date value of this object.

void Formattable::setDouble double  d  ) 
 

Sets the double value of this object.

void Formattable::setLong int32_t  l  ) 
 

Sets the long value of this object.

void Formattable::setString const UnicodeString stringToCopy  ) 
 

Sets the string value of this object.


The documentation for this class was generated from the following file:
Generated on Mon May 23 00:56:59 2005 for ICU 2.1 by  doxygen 1.4.2