// SMSLib for Java v3
// A Java API library for sending and receiving SMS via a GSM modem
// or other supported gateways.
// Web Site: http://www.smslib.org
//
// Copyright (C) 2002-2012, Thanasis Delenikas, Athens/GREECE.
// SMSLib is distributed under the terms of the Apache License version 2.0
//
// 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.smslib;

import java.util.Collection;
import java.util.LinkedList;
import org.smslib.Contact.ContactLocation;

/**
 * The Phonebook class represents the phonebook. All phonebook entries are kept
 * in the <b>contacts</b> collection. The class also provides some convinience /
 * filtering methods for retrieving the contacts.
 */
public class Phonebook
{
	private Collection<Contact> contacts;

	public Phonebook()
	{
		this.contacts = new LinkedList<Contact>();
	}

	/**
	 * Returns the contacts' collection with all (unfiltered) entries.
	 * 
	 * @return The contacts' collection.
	 */
	public Collection<Contact> getContacts()
	{
		return this.contacts;
	}

	/**
	 * Filters the contacts by contact type and returns a collection of contacts
	 * matching the criteria.
	 * 
	 * @param type
	 *            The contact type.
	 * @return The contacts' collection matching the criteria. If no matching
	 *         contact(s) is found, returns an empty collection.
	 */
	public Collection<Contact> getContacts(ContactLocation type)
	{
		String loc;
		Collection<Contact> filteredContacts = new LinkedList<Contact>();
		loc = Contact.convertTypeToLocation(type);
		if (loc.length() > 0)
		{
			for (Contact c : getContacts())
			{
				if (c.getMemLoc().equalsIgnoreCase(loc)) filteredContacts.add(c);
			}
		}
		return filteredContacts;
	}
}
