Coverage Report

Coverage Report - org.as3collections.IIterator

Classes in this File

0/1

 ﻿/*
  * Licensed under the MIT License
  * 
  * Copyright 2010 (c) Flávio Silva, http://flsilva.com
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
  * files (the "Software"), to deal in the Software without
  * restriction, including without limitation the rights to use,
  * copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the
  * Software is furnished to do so, subject to the following
  * conditions:
  *
  * The above copyright notice and this permission notice shall be
  * included in all copies or substantial portions of the Software.
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  * OTHER DEALINGS IN THE SOFTWARE.
  * 
  * http://www.opensource.org/licenses/mit-license.php
  */
 
 package org.as3collections
 {
         /**
          * An iterator over a collection.
          * 
          * @author Flávio Silva
          */
         public interface IIterator
         {
                 /**
                  * Returns <code>true</code> if the iteration has more elements.
                  * 
                  * @return         <code>true</code> if the iteration has more elements.
                   */
                 function hasNext(): Boolean;
 
                 /**
                  * Returns the next element in the iteration.
                  * 
                  * @throws         org.as3collections.errors.NoSuchElementError         if the iteration has no more elements.
                  * @return         the next element in the iteration.
                   */
                 function next(): *;
 
                 /**
                  * Returns the internal pointer of the iteration.
                  * <p>In a list or queue, the pointer should be the index (position) of the iteration, typically an <code>int</code>.</p>
                  * <p>In a map, the pointer should be the key of the iteration.</p>
                  * 
                  * @return         the internal pointer of the iteration.
                   */
                 function pointer(): *;
 
                 /**
                  * Removes from the underlying collection the last element returned by the iterator (optional operation).
                  * <p>This method can be called only once per call to <code>next</code>.</p>
                  * 
                  * @throws         org.as3coreaddendum.errors.UnsupportedOperationError          if the <code>remove</code> operation is not supported by this iterator.
                  * @throws         org.as3coreaddendum.errors.IllegalStateError                          if the <code>next</code> method has not yet been called, or the <code>remove</code> method has already been called after the last call to the <code>next</code> method.
                  */
                 function remove(): void;
 
                 /**
                  * Resets the internal pointer of the iterator.
                  */
                 function reset(): void;
         }
 
 }

1		/*
2		* Licensed under the MIT License
3		*
4		* Copyright 2010 (c) Flávio Silva, http://flsilva.com
5		*
6		* Permission is hereby granted, free of charge, to any person
7		* obtaining a copy of this software and associated documentation
8		* files (the "Software"), to deal in the Software without
9		* restriction, including without limitation the rights to use,
10		* copy, modify, merge, publish, distribute, sublicense, and/or sell
11		* copies of the Software, and to permit persons to whom the
12		* Software is furnished to do so, subject to the following
13		* conditions:
14		*
15		* The above copyright notice and this permission notice shall be
16		* included in all copies or substantial portions of the Software.
17		*
18		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19		* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20		* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21		* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22		* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23		* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24		* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25		* OTHER DEALINGS IN THE SOFTWARE.
26		*
27		* http://www.opensource.org/licenses/mit-license.php
28		*/
29
30	0	package org.as3collections
31		{
32		/**
33		* An iterator over a collection.
34		*
35		* @author Flávio Silva
36		*/
37		public interface IIterator
38		{
39		/**
40		* Returns <code>true</code> if the iteration has more elements.
41		*
42		* @return <code>true</code> if the iteration has more elements.
43		*/
44		function hasNext(): Boolean;
45
46		/**
47		* Returns the next element in the iteration.
48		*
49		* @throws org.as3collections.errors.NoSuchElementError if the iteration has no more elements.
50		* @return the next element in the iteration.
51		*/
52		function next(): *;
53
54		/**
55		* Returns the internal pointer of the iteration.
56		* <p>In a list or queue, the pointer should be the index (position) of the iteration, typically an <code>int</code>.</p>
57		* <p>In a map, the pointer should be the key of the iteration.</p>
58		*
59		* @return the internal pointer of the iteration.
60		*/
61		function pointer(): *;
62
63		/**
64		* Removes from the underlying collection the last element returned by the iterator (optional operation).
65		* <p>This method can be called only once per call to <code>next</code>.</p>
66		*
67		* @throws org.as3coreaddendum.errors.UnsupportedOperationError if the <code>remove</code> operation is not supported by this iterator.
68		* @throws org.as3coreaddendum.errors.IllegalStateError if the <code>next</code> method has not yet been called, or the <code>remove</code> method has already been called after the last call to the <code>next</code> method.
69		*/
70		function remove(): void;
71
72		/**
73		* Resets the internal pointer of the iterator.
74		*/
75		function reset(): void;
76		}
77
78		}