Class that represents a ustring primitive type. More...

#include <SPL/Runtime/Type/UString.h>

Public Member Functions

ustring ()

ustring (const char *codepageData, const char *codepage=0)

ustring (const char *codepageData, int32_t dataSize)

ustring (const char *codepageData, int32_t dataSize, const char *codepage)

ustring (const ustring &src, int32_t srcStart)

ustring (const ustring &src, int32_t srcStart, int32_t srcLength)

ustring (UChar src)

ustring (UChar32 src)

ustring (const UChar *src)

ustring (const UChar *src, int32_t srcLength)

ustring (const ustring &src)

~ustring ()

Destructor.

ustring & operator= (const ustring &src)

int32_t length () const

const UChar * getBuffer () const

bool operator== (const ustring &rhs) const

bool operator!= (const ustring &rhs) const

bool operator> (const ustring &rhs) const

bool operator>= (const ustring &rhs) const

bool operator< (const ustring &rhs) const

bool operator<= (const ustring &rhs) const

ustring & operator+= (UChar ch)

ustring & operator+= (UChar32 ch)

ustring & operator+= (const ustring &str)

ustring & append (const ustring &srcText, int32_t srcStart, int32_t srcLength)

ustring at (uint32_t index) const

size_t getSerializedSize () const

size_t hashCode () const

int32_t indexOf (ustring const &text) const

int32_t indexOf (ustring const &text, int32_t start) const

int32_t lastIndexOf (ustring const &text) const

int32_t lastIndexOf (ustring const &text, int32_t start) const

bool isEmpty () const

UChar32 char32At (int32_t offset) const

UChar charAt (int32_t offset) const

UChar operator[] (int32_t offset) const

int32_t moveIndex32 (int32_t index, int32_t delta) const

int32_t countChar32 (int32_t start=0, int32_t length=INT_MAX) const

ustring & toLower ()

ustring & toUpper ()

int32_t extract (int32_t start, int32_t startLength, char *target, const char *codepage=NULL) const

int32_t extract (int32_t start, int32_t startLength, char *target, uint32_t targetLength, const char *codepage) const

void extract (int32_t start, int32_t length, ustring &target) const

void remove ()

Remove all the characters in a ustring.

void remove (int32_t start, int32_t length=INT_MAX)

void truncate (int32_t targetLength)

int8_t compareCodePointOrder (const ustring &text) const

int8_t compareCodePointOrder (int32_t start, int32_t length, const ustring &srcText) const

Static Public Member Functions

static ustring fromUTF8 (char const *str)

static ustring fromUTF8 (char const *str, uint32_t len)

static ustring fromUTF8 (std::string const &str)

static ustring fromUTF8 (rstring const &str)

static rstring toUTF8 (ustring const &str)

template<class T >

static ustring toString (T const &value)

static ustring toString (rstring const &value)

static ustring toString (ustring const &value)

Detailed Description

Class that represents a ustring primitive type.

Constructor & Destructor Documentation

SPL::ustring::ustring ( )

explicit

Default constructor

SPL::ustring::ustring ( const char * codepageData,

const char * codepage = 0

)

Constructor

Parameters:

codepageData code page data to construct from

codepage code page to use

SPL::ustring::ustring ( const char * codepageData,

int32_t dataSize

)

Constructor

Parameters:

codepageData code page data to construct from

dataSize size of code page data in bytes

SPL::ustring::ustring ( const char * codepageData,

int32_t dataSize,

const char * codepage

)

Constructor

Parameters:

codepageData code page data to construct from

dataSize size of code page data in bytes

codepage code page data is encoded in

SPL::ustring::ustring ( const ustring & src,

int32_t srcStart

)

Constructor

Parameters:

src string to construct from

srcStart the offset into src at which to start copying

SPL::ustring::ustring ( const ustring & src,

int32_t srcStart,

int32_t srcLength

)

Constructor

Parameters:

src string to construct from

srcStart the offset into src at which to start copying

srcLength number of characters to copy

SPL::ustring::ustring ( UChar src )

Constructor

Parameters:

src character to construct from

SPL::ustring::ustring ( UChar32 src )

Constructor

Parameters:

src character to construct from

SPL::ustring::ustring ( const UChar * src )

Constructor

Parameters:

src string to construct from

SPL::ustring::ustring ( const UChar * src,

int32_t srcLength

)

Constructor

Parameters:

src string to construct from

srcLength number of characters to copy

SPL::ustring::ustring ( const ustring & src )

Copy Contrstructor

Parameters:

src string to construct from

SPL::ustring::~ustring ( )

Destructor.

Member Function Documentation

ustring& SPL::ustring::operator= ( const ustring & src )

Assignment operator

Parameters:

src ustring to assign

Returns:: reference to this

int32_t SPL::ustring::length ( ) const

Return the length of a ustring in UChars

Returns:: the number of UChar units in a ustring

const UChar* SPL::ustring::getBuffer ( ) const

Return a pointer to the ustring as a series of UChars

Returns:: a pointer to the UChars representing the ustring

bool SPL::ustring::operator== ( const ustring & rhs ) const

inline

Compare two unicode strings for equality

Parameters:

rhs ustring to compare to

Returns:: true if the strings are equal

bool SPL::ustring::operator!= ( const ustring & rhs ) const

inline

Compare two unicode strings for inequality

Parameters:

rhs ustring to compare to

Returns:: true if the strings are not equal

bool SPL::ustring::operator> ( const ustring & rhs ) const

inline

Compare two unicode strings for greater than

Parameters:

rhs ustring to compare to

Returns:: true if this ustring is greater than the rhs

bool SPL::ustring::operator>= ( const ustring & rhs ) const

inline

Compare two unicode strings for greater than or equal

Parameters:

rhs ustring to compare to

Returns:: true if this ustring is greater than or equal to the rhs

bool SPL::ustring::operator< ( const ustring & rhs ) const

inline

Compare two unicode strings for less than

Parameters:

rhs ustring to compare to

Returns:: true if this ustring is less than the rhs

bool SPL::ustring::operator<= ( const ustring & rhs ) const

inline

Compare two unicode strings for less than or equal

Parameters:

rhs ustring to compare to

Returns:: true if this ustring is less than or equal to the rhs

ustring& SPL::ustring::operator+= ( UChar ch )

Append a character to a ustring

Parameters:

ch the code unit to be appended

Returns:: a reference to this

ustring& SPL::ustring::operator+= ( UChar32 ch )

Append a character to a ustring

Parameters:

ch the code unit to be appended

Returns:: a reference to this

ustring& SPL::ustring::operator+= ( const ustring & str )

Append a ustring to a ustring

Parameters:

str the ustring to be appended

Returns:: a reference to this

ustring& SPL::ustring::append ( const ustring & srcText,

int32_t srcStart,

int32_t srcLength

)

Append a ustring to a ustring

Parameters:

srcText the ustring to be appended

srcStart the offset into src at which to start copying

srcLength number of characters to copy

Returns:: a reference to this

ustring SPL::ustring::at ( uint32_t index ) const

Select one character from a unicode string

Parameters:

index logical character position

Returns:: a ustring consisting of the logical character at position index

Exceptions:

SPLRuntimeInvalidIndexException exception if the index is out of range

static ustring SPL::ustring::fromUTF8 ( char const * str )

static

Create from UTF-8

Parameters:

str source string

Returns:: resulting ustring

Exceptions:

SPLRuntimeIllegalArgumentException exception if the string is not legal UTF-8

static ustring SPL::ustring::fromUTF8 ( char const * str,

uint32_t len

)

static

Create from UTF-8

Parameters:

str source string

len size (in bytes) of the source String

Returns:: resulting ustring

Exceptions:

SPLRuntimeIllegalArgumentException exception if the string is not legal UTF-8

static ustring SPL::ustring::fromUTF8 ( std::string const & str )

static

Create from UTF-8

Parameters:

str source string

Returns:: resulting ustring

Exceptions:

SPLRuntimeIllegalArgumentException exception if the string is not legal UTF-8

static ustring SPL::ustring::fromUTF8 ( rstring const & str )

static

Create from UTF-8

Parameters:

str source rstring

Returns:: resulting ustring

Exceptions:

SPLRuntimeIllegalArgumentException exception if the string is not legal UTF-8

static rstring SPL::ustring::toUTF8 ( ustring const & str )

static

Convert to UTF-8

Parameters:

str source ustring

Returns:: UTF-8 string

size_t SPL::ustring::getSerializedSize ( ) const

Get the size in bytes when serialized

Returns:: size in bytes when serialized

size_t SPL::ustring::hashCode ( ) const

Get the hash code

Returns:: hash code

int32_t SPL::ustring::indexOf ( ustring const & text ) const

Locate in this the first occurrence of the characters in text, using bitwise comparison

Parameters:

text The text to search for

Returns:: The offset into this of the start of text, or -1 if not found

int32_t SPL::ustring::indexOf ( ustring const & text,

int32_t start

) const

Locate in this the first occurrence of the characters in text, using bitwise comparison

Parameters:

text The text to search for

start The offset at which searching will start

Returns:: The offset into this of the start of text, or -1 if not found

int32_t SPL::ustring::lastIndexOf ( ustring const & text ) const

Locate in this the last occurrence of the characters in text, using bitwise comparison

Parameters:

text The text to search for

Returns:: The offset into this of the start of text, or -1 if not found

int32_t SPL::ustring::lastIndexOf ( ustring const & text,

int32_t start

) const

Locate in this the last occurrence of the characters in text, using bitwise comparison

Parameters:

text The text to search for

start The offset at which searching will start

Returns:: The offset into this of the start of text, or -1 if not found

bool SPL::ustring::isEmpty ( ) const

Is this string empty?

Returns:: 'true' if the string is empty, else 'false'

UChar32 SPL::ustring::char32At ( int32_t offset ) const

Return the code unit at offset offset

Parameters:

offset a valid offset into the text

Returns:: the code unit at offset offset or 0xffff if the offset is not valid for this string

UChar SPL::ustring::charAt ( int32_t offset ) const

Return the UChar at offset offset

Parameters:

offset a valid offset into the text

Returns:: the code unit at offset offset or 0xffff if the offset is not valid for this string

UChar SPL::ustring::operator[] ( int32_t offset ) const

inline

Return the UChar at offset offset

Parameters:

offset a valid offset into the text

Returns:: the code unit at offset offset or 0xffff if the offset is not valid for this string

int32_t SPL::ustring::moveIndex32 ( int32_t index,

int32_t delta

) const

Move the code unit index along the string by delta code points.

Parameters:

index input code unit index

delta (signed) code point count to move the index forward or backward in the string

Returns:: the resulting code unit index

int32_t SPL::ustring::countChar32 ( int32_t start = 0,

int32_t length = INT_MAX

) const

Count Unicode code points in the length UChar code units of the string

Parameters:

start the index of the first code unit to check

length the number of UChar code units to check

Returns:: the number of code points in the specified code units

ustring& SPL::ustring::toLower ( )

Convert to lower case

Returns:: a reference to this

ustring& SPL::ustring::toUpper ( )

Convert to upper case

Returns:: a reference to this

int32_t SPL::ustring::extract ( int32_t start,

int32_t startLength,

char * target,

const char * codepage = NULL

) const

Extract UChars from a ustring into a char buffer Copy the characters in the range [start, start + length) into the array dst

Parameters:

start offset of first character which will be copied into the array

startLength the number of characters to extract

target array in which to copy characters. The length of dst must be at least (dstStart + length)

codepage the desired codepage for the characters. NULL has the special meaning of the default codepage.

Returns:: the length of the output string, not counting the terminaling NUL

int32_t SPL::ustring::extract ( int32_t start,

int32_t startLength,

char * target,

uint32_t targetLength,

const char * codepage

) const

Extract UChars from a ustring into a char buffer Copy the characters in the range [start, start + length) into the array dst

Parameters:

start offset of first character which will be copied into the array

startLength the number of characters to extract

target array in which to copy characters. The length of dst must be at least (dstStart + length)

targetLength the size of the target buffer

codepage the desired codepage for the characters. NULL has the special meaning of the default codepage.

Returns:: the length of the output string, not counting the terminaling NUL

void SPL::ustring::extract ( int32_t start,

int32_t length,

ustring & target

) const

Extract UChars from a ustring into a ustring Copy the characters in the range [start, start + length) into the target

Parameters:

start offset of first character which will be copied

length the number of characters to extract

target ustring to copy the characters to.

void SPL::ustring::remove ( )

Remove all the characters in a ustring.

void SPL::ustring::remove ( int32_t start,

int32_t length = INT_MAX

)

Remove characters in a ustring

Parameters:

start the offset of the first character to remove

length the number of characters to remove

void SPL::ustring::truncate ( int32_t targetLength )

Truncate this ustring to the targetLength

Parameters:

targetLength the desired length of this ustring;

template<class T >

static ustring SPL::ustring::toString ( T const & value )

inlinestatic

Convert an SPL value to ustring

Parameters:

value value of SPL type

Returns:: ustring representation

static ustring SPL::ustring::toString ( rstring const & value )

static

static ustring SPL::ustring::toString ( ustring const & value )

inlinestatic

int8_t SPL::ustring::compareCodePointOrder ( const ustring & text ) const

Compare two ustrings in code point order

Parameters:

text ustring to compare to

Returns:: a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order

int8_t SPL::ustring::compareCodePointOrder ( int32_t start,

int32_t length,

const ustring & srcText

) const

Compare two ustrings in code point order

Parameters:

start The start offset in this string at which the compare operation begins.

length The number of code units from this string to compare.

srcText ustring to compare to

Returns:: a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order

The documentation for this class was generated from the following file:

SPL/Runtime/Type/UString.h