SIterator Class Reference
[Data Model]

#include <support/Iterator.h>

List of all members.

Detailed Description

Convenience class for using an IIterator/IIterable.

This class provides a wrapper around IIterator::Next(), to hide the batched retrieval of results. It also includes convenience methods for automatically retrieving an IIterator from an IIterable.


Bookkeeping

Creation, destruction. Note that copying is not supported because you can't correctly share the same IIterator between two SIterators.

status_t ErrorCheck () const
status_t SetTo (const sptr< IIterator > &it)
status_t SetTo (const sptr< IIterable > &dir, const SValue &args=B_UNDEFINED_VALUE)
status_t SetTo (const SContext &context, const SString &path, const SValue &args=B_UNDEFINED_VALUE)
 SIterator (const sptr< INode > &node, const SValue &args=B_UNDEFINED_VALUE)
 SIterator (const sptr< IIterator > &it)
 SIterator (const sptr< IIterable > &dir, const SValue &args=B_UNDEFINED_VALUE)
 SIterator (const SContext &context, const SString &path, const SValue &args=B_UNDEFINED_VALUE)
 SIterator ()
status_t StatusCheck () const
 ~SIterator ()

Iterating

Step over and manipulate iterator.

status_t Next (SValue *key, SValue *value, uint32_t flags=0, size_t count=0)
status_t Remove ()

Static Public Member Functions

static SValue ApplyFlags (const sptr< IIterable > &iterable, uint32_t flags)

Constructor & Destructor Documentation

SIterator (   ) 
 

Deprecated:
Use StatusCheck() instead.

SIterator (  const SContext &  context,
const SString &  path,
const SValue &  args = B_UNDEFINED_VALUE
) 
 

Deprecated:
Use StatusCheck() instead.

SIterator (  const sptr< IIterable > &  dir,
const SValue &  args = B_UNDEFINED_VALUE
) 
 

Deprecated:
Use StatusCheck() instead.

SIterator (  const sptr< IIterator > &  it  ) 
 

Deprecated:
Use StatusCheck() instead.

SIterator (  const sptr< INode > &  node,
const SValue &  args = B_UNDEFINED_VALUE
) 
 

Deprecated:
Use StatusCheck() instead.

~SIterator (   ) 
 

Deprecated:
Use StatusCheck() instead.

Member Function Documentation

SValue ApplyFlags (  const sptr< IIterable > &  iterable,
uint32_t  flags
)  [static]
 

status_t ErrorCheck (   )  const
 

Deprecated:
Use StatusCheck() instead.

status_t Next (  SValue *  key,
SValue *  value,
uint32_t  flags = 0,
size_t  count = 0
) 
 

status_t Remove (   ) 
 

status_t SetTo (  const sptr< IIterator > &  it  ) 
 

Deprecated:
Use StatusCheck() instead.

status_t SetTo (  const sptr< IIterable > &  dir,
const SValue &  args = B_UNDEFINED_VALUE
) 
 

Deprecated:
Use StatusCheck() instead.

status_t SetTo (  const SContext &  context,
const SString &  path,
const SValue &  args = B_UNDEFINED_VALUE
) 
 

Deprecated:
Use StatusCheck() instead.

status_t StatusCheck (   )  const
 

Deprecated:
Use StatusCheck() instead.

The documentation for this class was generated from the following files:
Generated on Wed Dec 28 22:33:32 2005 by Doxygen 1.4.4 for OpenBinder Documentation Version 1.0

PalmSource, Inc. © 2005