Enumerator

Kind of class:	class
Inherits from:	Dispatcher
Known subclasses:	ArrayEnumerator
Author:	Arthur Clemens
Classpath:	org.asapframework.data.Enumerator
File last modified:	Thursday, 12 October 2006, 11:19:40

► View source

▼ Hide source

/*
Copyright 2005-2006 by the authors of asapframework, http://asapframework.org

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import org.asapframework.events.Dispatcher;

/**
Virtual base class for enumerator objects.
@author Arthur Clemens
*/

class org.asapframework.data.Enumerator extends Dispatcher {

    public function Enumerator () {
        super();
    }
    
    /**
    Retrieves the object at the current pointer position.
    */
    public function getCurrentObject () : Object {
        return null;
    }
    
    /**
    Moves the pointer forward and returns the object at that position.
    */
    public function getNextObject () : Object {
        return null;
    }
    
    /**
    Creates an array of all objects. Original input order may not be preserved.
    */
    public function getAllObjects () : Array {
        return null;
    }
    
    /**
    Sets pointer position before the beginning of the first item.
    */
    public function reset () : Void {
        //
    }
    
}

Virtual base class for enumerator objects.

Summary

Constructor

Enumerator

Instance properties

Instance properties inherited from Dispatcher

addEventListener dispatchEvent removeEventListener

Instance methods

getCurrentObject : Object
- Retrieves the object at the current pointer position.
getNextObject : Object
- Moves the pointer forward and returns the object at that position.
getAllObjects : Array
- Creates an array of all objects.
reset : Void
- Sets pointer position before the beginning of the first item.

Constructor

Enumerator

function Enumerator (

)

Instance methods

getAllObjects

function getAllObjects (

) : Array

Creates an array of all objects. Original input order may not be preserved.

getCurrentObject

function getCurrentObject (

) : Object

Retrieves the object at the current pointer position.

getNextObject

function getNextObject (

) : Object

Moves the pointer forward and returns the object at that position.

reset

function reset (

) : Void

Sets pointer position before the beginning of the first item.