+Show TOC
×Hide TOC

Iterable

Kind of class:	public interface
Package:	com.bourre.collection
Inherits from:	none
Implemented by:	ParserCollection RecordSet
Known subinterfaces:	Collection IterationCommand
Author:	Cédric Néhémie
Classpath:	com.bourre.collection.Iterable
File last modified:	Wednesday, 09 January 2008, 12:22:12

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (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.mozilla.org/MPL/MPL-1.1.html
 * 
 * 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.
 */
package com.bourre.collection 
{
    /**
     * An object onto which the user can iterate using an <code>Iterator</code>
     * object provided by this <code>Iterable</code> object.
     * 
     * @author     C√©dric N√©h√©mie
     * @see        Iterator
     */
    public interface Iterable 
    {
        /**
         * Returns an iterator over the elements in this collection. There are no
         * guarantees concerning the order in which the elements are returned
         * (unless this collection is an instance of some class that provides a
         * guarantee).
         * 
         * @return an <code>Iterator</code> over the elements in this collection
         */
        function iterator () : Iterator;
    }
}

An object onto which the user can iterate using an Iteratorobject provided by this Iterable object.

Summary

Instance methods

iterator : Iterator
- Returns an iterator over the elements in this collection.

Instance methods

iterator

public function iterator (

) : Iterator

Returns an iterator over the elements in this collection. There are no
guarantees concerning the order in which the elements are returned
(unless this collection is an instance of some class that provides a
guarantee).

Returns:

an Iterator over the elements in this collection