org.nuiton.util.HashList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nuiton-utils Show documentation
Library of usefull class to be used in any project.
There is a newer version: 3.1
/*
 * #%L
 * Nuiton Utils
 * 
 * $Id: HashList.java 1948 2010-11-17 21:31:00Z sletellier $
 * $HeadURL: http://svn.nuiton.org/svn/nuiton-utils/tags/nuiton-utils-2.6.10/nuiton-utils/src/main/java/org/nuiton/util/HashList.java $
 * %%
 * Copyright (C) 2004 - 2010 CodeLutin
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * 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 General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */

/* *
 * HashList.java
 *
 * Created: 2 nov. 2004
 *
 * @author Benjamin Poussin 
 * @version $Revision: 1948 $
 *
 * Mise a jour: $Date: 2010-11-17 22:31:00 +0100 (Wed, 17 Nov 2010) $
 * par : */

package org.nuiton.util;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;

/**
 * Cette objet permet de gerer l'unicité des objets ajouté.
 * Lorsque l'on appelle la methode add sur cette objet, il verifie
 * en premier que l'objet n'est pas deja dans la liste. S'il y est
 * alors il n'est pas ajouter, sinon il est ajouter.
 * L'utilisation de la methode set n'est pas permise
 * 
 * FIXME: la serialisation n'est pas modifier, c-a-d que seul le tableau est
 * conserve et pas la hashSet, donc apres recuperation, l'uticite n'est plus
 * garantie. Il faut donc surcharger readObject et writeObject pour conserver
 * le HashSet
 */
public class HashList extends ArrayList { // HashList

    /**  */
    private static final long serialVersionUID = -334941610313293930L;

    protected HashSet set = new HashSet();

    public HashList() {
    }

    public HashList(Collection c) {
        addAll(c);
    }

    public HashList(int initialCapacity) {
        super(initialCapacity);
    }

    @Override
    public E set(int index, E element) {
        throw new UnsupportedOperationException("You can't use set method in HashList");
    }

    @Override
    public boolean add(E o) {
        boolean result = !contains(o);
        add(size(), o);
        return result;
    }

    @Override
    public void add(int index, E element) {
        if (set.add(element)) {
            super.add(index, element);
        }
    }

    /**
     * supprime l'element demandé. Si l'elment n'existe pas alors, null
     * est retrouné.
     */
    @Override
    public E remove(int index) {
        if (set.remove(get(index))) {
            return super.remove(index);
        }
        return null;
    }

    @Override
    public void clear() {
        set.clear();
        super.clear();
    }

    @Override
    public boolean addAll(Collection c) {
        boolean modified = false;
        for (E aC : c) {
            if (add(aC))
                modified = true;
        }
        return modified;

    }

    @Override
    public boolean addAll(int index, Collection c) {
        boolean modified = false;
        for (E aC : c) {
            add(index++, aC);
            modified = true;
        }
        return modified;

    }

    @Override
    protected void removeRange(int fromIndex, int toIndex) {
        for (int i = toIndex - 1; i >= fromIndex; i--) {
            remove(i);
        }
    }

    @Override
    public boolean contains(Object elem) {
        return set.contains(elem);
    }

    @Override
    public Object clone() {
        HashList result = new HashList(this);
        return result;
    }

} // HashList