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

UnicodeToHexTransliterator Class Reference

A transliterator that converts from Unicode characters to hexadecimal Unicode escape sequences. More...

#include <unitohex.h>

Inheritance diagram for UnicodeToHexTransliterator:

Transliterator

Public Member Functions

 UnicodeToHexTransliterator (const UnicodeString &pattern, UBool isUppercase, UnicodeFilter *adoptedFilter, UErrorCode &status)
 Constructs a transliterator.
 UnicodeToHexTransliterator (const UnicodeString &pattern, UErrorCode &status)
 Constructs an uppercase transliterator with no filter.
 UnicodeToHexTransliterator (UnicodeFilter *adoptedFilter=0)
 Constructs a transliterator with the default prefix "\u" that outputs uppercase hex digits.
virtual ~UnicodeToHexTransliterator ()
 Destructor.
 UnicodeToHexTransliterator (const UnicodeToHexTransliterator &)
 Copy constructor.
UnicodeToHexTransliteratoroperator= (const UnicodeToHexTransliterator &)
 Assignment operator.
virtual Transliteratorclone (void) const
 Transliterator API.
void applyPattern (const UnicodeString &thePattern, UErrorCode &status)
 Set the pattern recognized by this transliterator.
const UnicodeStringtoPattern (void) const
 Return this transliterator's pattern.
virtual UBool isUppercase (void) const
 Returns true if this transliterator outputs uppercase hex digits.
virtual void setUppercase (UBool outputUppercase)
 Sets if this transliterator outputs uppercase hex digits.
virtual void handleTransliterate (Replaceable &text, UTransPosition &offsets, UBool isIncremental) const
 Implements Transliterator#handleTransliterate.

Detailed Description

A transliterator that converts from Unicode characters to hexadecimal Unicode escape sequences.

It outputs a prefix specified in the constructor and optionally converts the hex digits to uppercase.

The format of the output is set by a pattern. This pattern follows the same syntax as HexToUnicodeTransliterator, except it does not allow multiple specifications. The pattern sets the prefix string, suffix string, and minimum and maximum digit count. There are no setters or getters for these attributes; they are set only through the pattern.

The setUppercase() and isUppercase() methods control whether 'a' through 'f' or 'A' through 'F' are output as hex digits. This is not controlled through the pattern; only through the methods. The default is uppercase.

Author:
Alan Liu
Deprecated:
To be removed after 2002-sep-30.


Constructor & Destructor Documentation

UnicodeToHexTransliterator::UnicodeToHexTransliterator const UnicodeString pattern,
UBool  isUppercase,
UnicodeFilter adoptedFilter,
UErrorCode status
 

Constructs a transliterator.

Parameters:
pattern The pattern for this transliterator. See applyPattern() for pattern syntax.
uppercase if true, the four hex digits will be converted to uppercase; otherwise they will be lowercase.
adoptedFilter the filter for this transliterator, or NULL if none. Adopted by this transliterator.
status Error code indicating success or failure to parse pattern.
Deprecated:
To be removed after 2002-sep-30; use Transliterator::createInstance factory method.

UnicodeToHexTransliterator::UnicodeToHexTransliterator const UnicodeString pattern,
UErrorCode status
 

Constructs an uppercase transliterator with no filter.

Parameters:
pattern The pattern for this transliterator. See applyPattern() for pattern syntax.
status Error code indicating success or failure to parse pattern.
Deprecated:
To be removed after 2002-sep-30; use Transliterator::createInstance factory method.

UnicodeToHexTransliterator::UnicodeToHexTransliterator UnicodeFilter adoptedFilter = 0  ) 
 

Constructs a transliterator with the default prefix "\u" that outputs uppercase hex digits.

Deprecated:
To be removed after 2002-sep-30; use Transliterator::createInstance factory method.

UnicodeToHexTransliterator::~UnicodeToHexTransliterator  )  [inline, virtual]
 

Destructor.

Deprecated:
To be removed after 2002-sep-30.

UnicodeToHexTransliterator::UnicodeToHexTransliterator const UnicodeToHexTransliterator  ) 
 

Copy constructor.

Deprecated:
To be removed after 2002-sep-30; use Transliterator::createInstance factory method.


Member Function Documentation

void UnicodeToHexTransliterator::applyPattern const UnicodeString thePattern,
UErrorCode status
 

Set the pattern recognized by this transliterator.

The pattern must contain zero or more prefix characters, one or more digit characters, and zero or more suffix characters. The digit characters indicates optional digits ('#') followed by required digits ('0'). The total number of digits cannot exceed 4, and must be at least 1 required digit. Use a backslash ('\') to escape any of the special characters. An empty pattern is not allowed.

Example: "U+0000" specifies a prefix of "U+", exactly four digits, and no suffix. "<###0>" has a prefix of "<", between one and four digits, and a suffix of ">".

 pattern := prefix-char* digit-spec suffix-char*
 digit-spec := '#'* '0'+
 prefix-char := [^special-char] | '\' special-char
 suffix-char := [^special-char] | '\' special-char
 special-char := ';' | '0' | '#' | '\'
 

Limitations: There is no way to set the uppercase attribute in the pattern. (applyPattern() does not alter the uppercase attribute.)

Deprecated:
To be removed after 2002-sep-30.

virtual Transliterator* UnicodeToHexTransliterator::clone void   )  const [virtual]
 

Transliterator API.

Deprecated:
To be removed after 2002-sep-30.

Reimplemented from Transliterator.

virtual void UnicodeToHexTransliterator::handleTransliterate Replaceable text,
UTransPosition offsets,
UBool  isIncremental
const [virtual]
 

Implements Transliterator#handleTransliterate.

Deprecated:
To be removed after 2002-sep-30.

Implements Transliterator.

virtual UBool UnicodeToHexTransliterator::isUppercase void   )  const [virtual]
 

Returns true if this transliterator outputs uppercase hex digits.

Deprecated:
To be removed after 2002-sep-30.

UnicodeToHexTransliterator& UnicodeToHexTransliterator::operator= const UnicodeToHexTransliterator  ) 
 

Assignment operator.

virtual void UnicodeToHexTransliterator::setUppercase UBool  outputUppercase  )  [virtual]
 

Sets if this transliterator outputs uppercase hex digits.

Deprecated:
To be removed after 2002-sep-30.

const UnicodeString& UnicodeToHexTransliterator::toPattern void   )  const
 

Return this transliterator's pattern.

Deprecated:
To be removed after 2002-sep-30.


The documentation for this class was generated from the following file:
Generated on Sun May 22 23:05:52 2005 for ICU 2.1 by  doxygen 1.4.2