Jmw\Collection\ImmutableCollectionTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	add()	0	4	1
A	addAll()	0	4	1
A	clear()	0	4	1
A	remove()	0	4	1
A	removeAll()	0	4	1
A	retainAll()	0	4	1

<?php
namespace Jmw\Collection;

use Jmw\Collection\Exception\UnsupportedOperationException;
/**
 * This trait is ensures immutability by throwing an exception
 * on all mutable CollectionInterface methods
 * @author john
 *
 */
trait ImmutableCollectionTrait
{
	/**
	 * add is not supported by immutable objects.
	 * @param multitype $element
	 * @throws UnsupportedOperationException
	 */
	public function add($element)

The parameter $element is not used and could be removed.

	{
		throw new UnsupportedOperationException('add');
	}
	
	/**
	 * addAll is not supported by immutable objects.
	 * @param CollectionInterface $collection
 	 * @throws UnsupportedOperationException
	 */
	public function addAll(CollectionInterface $collection)

The parameter $collection is not used and could be removed.

	{
		throw new UnsupportedOperationException('addAll');
	}
	
	/**
	 * clear is not supported by immutable objects.
 	 * @throws UnsupportedOperationException
	 */
	public function clear()
	{
		throw new UnsupportedOperationException('clear');
	}

	/**
	 * Remove is not supported by immutable objects.
	 * @param multitype $element
 	 * @throws UnsupportedOperationException
	 */
	public function remove($element)

The parameter $element is not used and could be removed.

	{
		throw new UnsupportedOperationException('remove');
	}
	
	/**
	 * removeAll is not supported by immutable objects.
	 * @param CollectionInterface $collection
	 */
	public function removeAll(CollectionInterface $collection)

The parameter $collection is not used and could be removed.

	{
		throw new UnsupportedOperationException('removeAll');
	}

	/**
	 * retainAll is not supported by immutable objects.
	 * @param CollectionInterface $collection
 	 * @throws UnsupportedOperationException
	 */
	public function retainAll(CollectionInterface $collection)

The parameter $collection is not used and could be removed.

	{
		throw new UnsupportedOperationException('retainAll');
	}
	
}