Oracle Coherence for C++ API
Release 3.6.1.0

E18813-01

LongArrayIterator Class Reference

#include <coherence/util/LongArrayIterator.hpp>

Inherits Muterator.

List of all members.


Detailed Description

A LongArray specific iterator that adds a "current element" concept.
Author:
js 2008.04.04

Public Types

typedef spec::Handle  Handle
  LongArrayIterator Handle definition.
typedef spec::View  View
  LongArrayIterator View definition.
typedef spec::Holder  Holder
  LongArrayIterator Holder definition.

Public Member Functions

virtual int64_t  getIndex () const =0
  Returns the index of the current value, which is the value returned by the most recent call to the next method.
virtual Object::Holder  getValue () const =0
  Returns the current value, which is the same value returned by the most recent call to the next method, or the most recent value passed to setValue if setValue were called after the next method.
virtual Object::Holder  setValue (Object::Holder oValue)=0
  Stores a new value at the current value index, returning the value that was replaced.
virtual void  remove ()=0
  Removes from the underlying collection the last element returned by the iterator (optional operation).

Member Function Documentation

virtual int64_t getIndex (  )  const [pure virtual]

Returns the index of the current value, which is the value returned by the most recent call to the next method.

Returns:
the current index
Exceptions:
IllegalStateException  if the next method has not yet been called, or the remove method has already been called after the last call to the next method.

virtual Object::Holder getValue (  )  const [pure virtual]

Returns the current value, which is the same value returned by the most recent call to the next method, or the most recent value passed to setValue if setValue were called after the next method.

Returns:
the current value
Exceptions:
IllegalStateException  if the next method has not yet been called, or the remove method has already been called after the last call to the next method.

virtual Object::Holder setValue ( Object::Holder  oValue  )  [pure virtual]

Stores a new value at the current value index, returning the value that was replaced.

The index of the current value is obtainable by calling the getIndex method.

Returns:
the replaced value
Exceptions:
UnsupportedOperationException  if the remove operation is not supported by this Iterator
IllegalStateException  if the next method has not yet been called, or the remove method has already been called after the last call to the next method.

virtual void remove (  )  [pure virtual]

Removes from the underlying collection the last element returned by the iterator (optional operation).

This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

Exceptions:
UnsupportedOperationException  if the remove operation is not supported by this Iterator
IllegalStateException  if the next method has not yet been called, or the remove method has already been called after the last call to the next method.

Implements Muterator.


The documentation for this class was generated from the following file:
Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.