/**

  * Distribution License:

  * JSword is free software; you can redistribute it and/or modify it under

  * the terms of the GNU Lesser General Public License, version 2.1 or later

  * as published by the Free Software Foundation. This program is distributed

  * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even

  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  * See the GNU Lesser General Public License for more details.

  *

  * The License is available on the internet at:

  *      http://www.gnu.org/copyleft/lgpl.html

  * or by writing to:

  *      Free Software Foundation, Inc.

  *      59 Temple Place - Suite 330

  *      Boston, MA 02111-1307, USA

  *

  * © CrossWire Bible Society, 2005 - 2016

  *

  */

 package org.crosswire.jsword.passage;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import java.util.Set;

 import org.slf4j.Logger;

 import org.slf4j.LoggerFactory;

 /**

  * A Key that uses a Set of Keys as it's store of data.

  * 

  * @see gnu.lgpl.License The GNU Lesser General Public License for details.

  * @author Joe Walker

  */

 public class SetKeyList extends AbstractKeyList {

     /**

      * Simple ctor

      * @param set 

      */

     public SetKeyList(Set<Key> set) {

         this(set, null, null);

     }

     /**

      * Simple ctor

      * @param set 

      * @param name 

      */

     public SetKeyList(Set<Key> set, String name) {

         this(set, null, name);

     }

     /**

      * Simple ctor

      * @param set 

      * @param parent 

      */

     public SetKeyList(Set<Key> set, Key parent) {

         this(set, parent, null);

     }

     /**

      * Simple ctor

      * @param set 

      * @param parent 

      * @param name 

      */

     public SetKeyList(Set<Key> set, Key parent, String name) {

         super(name);

         this.parent = parent;

         list.addAll(set);

     }

     /*

      * (non-Javadoc)

      * 

      * @see

      * org.crosswire.jsword.passage.Key#add(org.crosswire.jsword.passage.Key)

      */

     public void addAll(Key key) {

         list.add(key);

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.crosswire.jsword.passage.Key#clear()

      */

     public void clear() {

         list.clear();

     }

     /*

      * (non-Javadoc)

      * 

      * @see

      * org.crosswire.jsword.passage.Key#contains(org.crosswire.jsword.passage

      * .Key)

      */

     @Override

     public boolean contains(Key key) {

         return list.contains(key);

     }

     /*

      * (non-Javadoc)

      * 

      * @see java.lang.Object#equals(java.lang.Object)

      */

     @Override

     public boolean equals(Object obj) {

         if (obj instanceof SetKeyList) {

             SetKeyList that = (SetKeyList) obj;

             return list.equals(that.list);

         }

         return false;

     }

     /*

      * (non-Javadoc)

      * 

      * @see java.lang.Object#hashCode()

      */

     @Override

     public int hashCode() {

         return list.hashCode();

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.crosswire.jsword.passage.Key#isEmpty()

      */

     @Override

     public boolean isEmpty() {

         return list.isEmpty();

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.crosswire.jsword.passage.Key#iterator()

      */

     public Iterator<Key> iterator() {

         return list.iterator();

     }

     /*

      * (non-Javadoc)

      * 

      * @see

      * org.crosswire.jsword.passage.Key#remove(org.crosswire.jsword.passage.Key)

      */

     public void removeAll(Key key) {

         list.remove(key);

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.crosswire.jsword.passage.Key#getCardinality()

      */

     public int getCardinality() {

         return list.size();

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.crosswire.jsword.passage.Key#canHaveChildren()

      */

     public boolean canHaveChildren() {

         return false;

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.crosswire.jsword.passage.Key#getChildCount()

      */

     public int getChildCount() {

         return 0;

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.crosswire.jsword.passage.Key#get(int)

      */

     public Key get(int index) {

         return list.get(index);

     }

     /*

      * (non-Javadoc)

      * 

      * @see

      * org.crosswire.jsword.passage.Key#indexOf(org.crosswire.jsword.passage

      * .Key)

      */

     public int indexOf(Key that) {

         return list.indexOf(that);

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.crosswire.jsword.passage.Key#getParent()

      */

     public Key getParent() {

         return parent;

     }

     /*

      * (non-Javadoc)

      * 

      * @see org.crosswire.jsword.passage.Key#blur(int)

      */

     public void blur(int by, RestrictionType restrict) {

         log.warn("attempt to blur a non-blur-able list");

     }

     /**

      * The parent of this key

      */

     private Key parent;

     /**

      * The Set that we are proxying to

      */

     private List<Key> list = new ArrayList<Key>();

     /**

      * Serialization ID

      */

     private static final long serialVersionUID = -1460162676283475117L;

     /**

      * The log stream

      */

     private static final Logger log = LoggerFactory.getLogger(SetKeyList.class);

 }