Class: KXI::Collections::Enumerator Abstract

Inherits:

Object

• Object
• KXI::Collections::Enumerator

Defined in:

lib/kxi/collections/enumerator.rb

Overview

This class is abstract.

Allows iteration over a collection

Direct Known Subclasses

ArrayCollection::ArrayEnumerator, HashCollection::HashEnumerator

Instance Method Summary

• #current ⇒ Object abstract

  Returns current item.

• #next ⇒ Bool abstract

  Advances enumerator to next item.

• #rewind ⇒ Bool abstract

  Selects first item in collection.

Instance Method Details

#current ⇒ Object

This method is abstract.

Returns current item

Returns:

• (Object) —

  Current item

Raises:

• (KXI::Exceptions::AbstractException) —

  When method is not implemented in superclass

# File 'lib/kxi/collections/enumerator.rb', line 27

def current
	raise(KXI::Exceptions::AbstractException.new(Enumerator))
end

#next ⇒ Bool

This method is abstract.

Advances enumerator to next item

Returns:

• (Bool) —

  True if item is available; false otherwise

Raises:

• (KXI::Exceptions::AbstractException) —

  When method is not implemented in superclass

# File 'lib/kxi/collections/enumerator.rb', line 19

def next
	raise(KXI::Exceptions::AbstractException.new(Enumerator))
end

#rewind ⇒ Bool

This method is abstract.

Selects first item in collection

Returns:

• (Bool) —

  True if collection contains elements; otherwise false

Raises:

• (KXI::Exceptions::AbstractException)

# File 'lib/kxi/collections/enumerator.rb', line 11

def rewind
	raise(KXI::Exceptions::AbstractException.new(Enumerator))
end