Coverage Report

Coverage Report - org.as3collections.iterators.ReadOnlyMapIterator

Classes in this File

Line Coverage

Branch Coverage

Complexity

ReadOnlyMapIterator

100%

4/4

N/A

 /*
  * 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.iterators {
         import org.as3collections.IMap;
         import org.as3coreaddendum.errors.UnsupportedOperationError;
         import org.as3utils.ReflectionUtil;
 
         /**
          * An iterator to iterate over maps (implementations of the <code>IMap</code> interface).
          * This implementation doesn't allow modifications in the map.
          * All methods that change the map will throw an <code>UnsupportedOperationError</code>.
          * 
          * @author Flávio Silva
          */
         public class ReadOnlyMapIterator extends MapIterator
         {
                 /**
                  * Constructor, creates a new <code>ReadOnlyMapIterator</code> object.
                  * 
                  * @param          source         the source map to iterate over.
                  * @throws         ArgumentError  if the <code>source</code> argument is <code>null</code>.
                  */
                 public function ReadOnlyMapIterator(source:IMap)
                 {
                         super(source);
                 }
 
                 /**
                  * This implementation always throws an <code>UnsupportedOperationError</code>.
                  * 
                  * @throws         org.as3coreaddendum.errors.UnsupportedOperationError          <code>ReadOnlyMapIterator</code> is a read-only iterator and doesn't allow modifications in the map.
                  */
                 override public function remove(): void
                 {
                         throw new UnsupportedOperationError(ReflectionUtil.getClassName(this) + " is a read-only iterator and doesn't allow modifications in the collection.");
                 }
 
         }
 
 }

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	1	package org.as3collections.iterators {
31		import org.as3collections.IMap;
32		import org.as3coreaddendum.errors.UnsupportedOperationError;
33		import org.as3utils.ReflectionUtil;
34
35		/**
36		* An iterator to iterate over maps (implementations of the <code>IMap</code> interface).
37		* This implementation doesn't allow modifications in the map.
38		* All methods that change the map will throw an <code>UnsupportedOperationError</code>.
39		*
40		* @author Flávio Silva
41		*/
42		public class ReadOnlyMapIterator extends MapIterator
43		{
44		/**
45		* Constructor, creates a new <code>ReadOnlyMapIterator</code> object.
46		*
47		* @param source the source map to iterate over.
48		* @throws ArgumentError if the <code>source</code> argument is <code>null</code>.
49		*/
50		public function ReadOnlyMapIterator(source:IMap)
51		{
52	1	super(source);
53	1	}
54
55		/**
56		* This implementation always throws an <code>UnsupportedOperationError</code>.
57		*
58		* @throws org.as3coreaddendum.errors.UnsupportedOperationError <code>ReadOnlyMapIterator</code> is a read-only iterator and doesn't allow modifications in the map.
59		*/
60		override public function remove(): void
61		{
62	1	throw new UnsupportedOperationError(ReflectionUtil.getClassName(this) + " is a read-only iterator and doesn't allow modifications in the collection.");
63		}
64
65		}
66
67		}