icu::FieldPositionIterator Class Reference

FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Format::format. More...

#include <fpositer.h>

Inheritance diagram for icu::FieldPositionIterator:

icu::UObject icu::UMemory

Public Member Functions

 ~FieldPositionIterator ()
 Destructor.
 FieldPositionIterator (void)
 Constructs a new, empty iterator.
 FieldPositionIterator (const FieldPositionIterator &)
 Copy constructor.
UBool operator== (const FieldPositionIterator &) const
 Return true if another object is semantically equal to this one.
UBool operator!= (const FieldPositionIterator &rhs) const
 Returns the complement of the result of operator==.
UBool next (FieldPosition &fp)
 If the current position is valid, updates the FieldPosition values, advances the iterator, and returns TRUE, otherwise returns FALSE.

Friends

class FieldPositionIteratorHandler

Detailed Description

FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Format::format.

See Format, NumberFormat, DecimalFormat.

Stable:
ICU 4.4

Definition at line 53 of file fpositer.h.


Constructor & Destructor Documentation

icu::FieldPositionIterator::~FieldPositionIterator (  ) 

Destructor.

Stable:
ICU 4.4

icu::FieldPositionIterator::FieldPositionIterator ( void   ) 

Constructs a new, empty iterator.

Stable:
ICU 4.4

icu::FieldPositionIterator::FieldPositionIterator ( const FieldPositionIterator  ) 

Copy constructor.

If the copy failed for some reason, the new iterator will be empty.

Stable:
ICU 4.4


Member Function Documentation

UBool icu::FieldPositionIterator::next ( FieldPosition fp  ) 

If the current position is valid, updates the FieldPosition values, advances the iterator, and returns TRUE, otherwise returns FALSE.

Stable:
ICU 4.4

UBool icu::FieldPositionIterator::operator!= ( const FieldPositionIterator rhs  )  const [inline]

Returns the complement of the result of operator==.

Parameters:
rhs The FieldPositionIterator to be compared for inequality
Returns:
the complement of the result of operator==
Stable:
ICU 4.4

Definition at line 90 of file fpositer.h.

References icu::operator==().

UBool icu::FieldPositionIterator::operator== ( const FieldPositionIterator  )  const

Return true if another object is semantically equal to this one.

Return true if this FieldPositionIterator is at the same position in an equal array of run values.

Stable:
ICU 4.4


The documentation for this class was generated from the following file:
Generated on 27 Oct 2013 for ICU 50.1.2 by  doxygen 1.4.7