/*******************************************************************************
 * Copyright (c) 2013 Jens Kristian Villadsen.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Public License v3.0
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/gpl.html
 * 
 * Contributors:
 *     Jens Kristian Villadsen - Lead developer, owner and creator
 ******************************************************************************/
/*
 * Digital Audio Access Protocol (DAAP) Library
 * Copyright (C) 2004-2010 Roger Kapsi
 *
 * 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.
 */

package org.dyndns.jkiddo.dmp.chunks;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.NoSuchElementException;

import org.dyndns.jkiddo.dmp.IDmapProtocolDefinition.DmapTypeDefinition;

import com.google.common.base.Predicates;
import com.google.common.collect.Iterables;

/**
 * A container contains a series of other chunks.
 * 
 * @author Roger Kapsi
 */
public class ContainerChunk extends AbstractChunk implements Iterable<Chunk>
{

	protected Collection<Chunk> collection;

	/**
	 * Creates a new ContainerChunk with an <tt>ArrayList</tt> as the underlying collection.
	 */
	protected ContainerChunk(final String type, final String name)
	{
		super(type, name);
		this.collection = new ArrayList<>();
	}

	/**
	 * Adds <tt>chunk</tt> to this container
	 */
	public void add(final Chunk chunk)
	{
		if(chunk == null)
		{
			throw new IllegalArgumentException();
		}
		collection.add(chunk);
	}

	public void addAll(final Collection<Chunk> chunk)
	{
		if(chunk == null)
		{
			throw new IllegalArgumentException();
		}
		collection.addAll(chunk);
	}

	@Override
	public Iterator<Chunk> iterator()
	{
		return Collections.unmodifiableCollection(collection).iterator();
	}

	/**
	 * Returns the number of childs
	 */
	public int size()
	{
		return collection.size();
	}

	/**
	 * Returns {@see Chunk.CONTAINER_TYPE}
	 */
	@Override
	public DmapTypeDefinition getType()
	{
		return DmapTypeDefinition.CONTAINER_TYPE;
	}

	@Override
	public String toString(final int indent)
	{
		final StringBuilder buffer = new StringBuilder(indent(indent));
		buffer.append(name).append("(").append(getContentCodeString()).append("; container)\n");

		if(collection != null)
		{
			final Iterator<Chunk> it = iterator();
			while(it.hasNext())
			{
				final Chunk chunk = it.next();
				buffer./* append(i).append(": "). */append(indent(indent + 4) + chunk.toString());
				if(it.hasNext())
				{
					buffer.append("\n");
				}
			}
		}
		return buffer.toString();
	}

	@SuppressWarnings("unchecked")
	protected <T extends Chunk> T getSingleChunk(final Class<T> clazz)
	{
		final Iterable<Chunk> iterables = Iterables.filter(this.collection, Predicates.instanceOf(clazz));
		if(Iterables.size(iterables) == 1)
		{
			return (T) iterables.iterator().next();
		}
		if(Iterables.size(iterables) == 0)
		{
			return null;
		}
		throw new NoSuchElementException("Multiple chunks of type " + clazz + " was found");
	}

	protected <T extends Chunk> Iterable<T> getMultipleChunks(final Class<T> clazz)
	{
		return Iterables.filter(collection, clazz);
		/*Iterable<T> iterables = Iterables.filter(collection, clazz);
		if(Iterables.size(iterables) > 0)
		{
			return iterables;
		}
		throw new NoSuchElementException("Chunks of type " + clazz + " could not be found");*/
	}

	@Override
	public void setObjectValue(final Object object)
	{
		System.out.println("setObjectValue(Object object) does not apply for ContainerChunks");
	}
}