FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoStringCollection Class Reference

#include <StringCollection.h>

Inherits FdoCollection< FdoStringElement, FdoException >.

Inheritance diagram for FdoStringCollection:

[legend]
List of all members.

Detailed Description

FdoStringCollection is a collection of strings.

Definition at line 81 of file StringCollection.h.


Public Member Functions

FDO_API_COMMON int Add (FdoStringP src)
 Adds a string to the end of this collection.
FDO_API_COMMON void Append (const FdoStringCollection &src)
 Appends the strings from src to the end of this collection.
FDO_API_COMMON FdoStringGetString (int index) const
 Gets the string in the collection at the specified index. Throws an invalid argument exception if the index is out of range.
virtual FDO_API_COMMON FdoInt32 IndexOf (FdoStringP value, FdoBoolean caseSensitive=true) const
 Given a string, returns its position in this collection.
FDO_API_COMMON FdoStringP ToString (FdoString *separator=L", ")
 Concatenates the strings in this collection.

Static Public Member Functions

FDO_API_COMMON FdoStringCollectionCreate (const FdoStringP &inString, FdoString *delimiters, bool bNullTokens=false)
 Creates a string collection that is tokenize from a string. The collection contains an element for each token.
FDO_API_COMMON FdoStringCollectionCreate (const FdoStringCollection *src)
 Creates a copy of string collection.
FDO_API_COMMON FdoStringCollectionCreate (const FdoStringCollection &src)
 Creates a copy of string collection.
FDO_API_COMMON FdoStringCollectionCreate (void)
 Constructs a new empty string collection.

Protected Member Functions

virtual FDO_API_COMMON void Dispose ()
 
FDO_API_COMMON FdoStringCollection (const FdoStringP &inString, FdoString *delimiters, bool bNullTokens=false)
FDO_API_COMMON FdoStringCollection (const FdoStringCollection *src)
FDO_API_COMMON FdoStringCollection (const FdoStringCollection &src)
FDO_API_COMMON FdoStringCollection (void)
 DOXYGEN-IGNORE
virtual FDO_API_COMMON ~FdoStringCollection (void)

Constructor & Destructor Documentation

FDO_API_COMMON FdoStringCollection::FdoStringCollection void   )  [protected]
 

DOXYGEN-IGNORE

FDO_API_COMMON FdoStringCollection::FdoStringCollection const FdoStringCollection src  )  [protected]
 

FDO_API_COMMON FdoStringCollection::FdoStringCollection const FdoStringCollection src  )  [protected]
 

FDO_API_COMMON FdoStringCollection::FdoStringCollection const FdoStringP inString,
FdoString delimiters,
bool  bNullTokens = false
[protected]
 

virtual FDO_API_COMMON FdoStringCollection::~FdoStringCollection void   )  [protected, virtual]
 


Member Function Documentation

FDO_API_COMMON int FdoStringCollection::Add FdoStringP  src  ) 
 

Adds a string to the end of this collection.

Parameters:
src Input the source collection

FDO_API_COMMON void FdoStringCollection::Append const FdoStringCollection src  ) 
 

Appends the strings from src to the end of this collection.

Parameters:
src Input the source collection

FDO_API_COMMON FdoStringCollection* FdoStringCollection::Create const FdoStringP inString,
FdoString delimiters,
bool  bNullTokens = false
[static]
 

Creates a string collection that is tokenize from a string. The collection contains an element for each token.

Parameters:
inString Input the string to tokenize.
delimiters Input list of single character token delimiters.
bNullTokens true: include zero-length tokens in the collection. false: exclude zero-length tokens
Returns:
Returns FdoStringCollection

FDO_API_COMMON FdoStringCollection* FdoStringCollection::Create const FdoStringCollection src  )  [static]
 

Creates a copy of string collection.

Parameters:
src Input pointer to the source collection
Returns:
Returns FdoStringCollection

FDO_API_COMMON FdoStringCollection* FdoStringCollection::Create const FdoStringCollection src  )  [static]
 

Creates a copy of string collection.

Parameters:
src Input the source collection
Returns:
Returns FdoStringCollection

FDO_API_COMMON FdoStringCollection* FdoStringCollection::Create void   )  [static]
 

Constructs a new empty string collection.

Returns:
Returns FdoStringCollection

virtual FDO_API_COMMON void FdoStringCollection::Dispose  )  [inline, protected, virtual]
 

Implements FdoIDisposable.

Definition at line 197 of file StringCollection.h.

References FDO_API_COMMON.

FDO_API_COMMON FdoString* FdoStringCollection::GetString int  index  )  const
 

Gets the string in the collection at the specified index. Throws an invalid argument exception if the index is out of range.

Parameters:
index Input index
Returns:
Returns the string in the collection at the specified index

virtual FDO_API_COMMON FdoInt32 FdoStringCollection::IndexOf FdoStringP  value,
FdoBoolean  caseSensitive = true
const [virtual]
 

Given a string, returns its position in this collection.

Parameters:
value Input the string to check
caseSensitive Input if true, do a case-sensitive comparison of the string and members of this collection. If false, the comparison is case-insensitive.
Returns:
Returns the string's position. Returns -1 if the string is not in this collection.

FDO_API_COMMON FdoStringP FdoStringCollection::ToString FdoString separator = L", "  ) 
 

Concatenates the strings in this collection.

Parameters:
separator Input separate each collection string with this separator string.
Returns:
Returns the concatenation if all strings in this collection.
Returns a concatenation of all the strings in this collection, separated by the given separator.

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.