FeatureGroup.java

/***************************************************
*
* cismet GmbH, Saarbruecken, Germany
*
*              ... and it just works.
*
****************************************************/
/*
 *  Copyright (C) 2010 thorsten
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU 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 Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package de.cismet.cismap.commons.features;

import java.util.Collection;

/**
 * DOCUMENT ME!
 *
 * @author   thorsten
 * @version  $Revision$, $Date$
 */
public interface FeatureGroup extends SubFeature, Iterable<Feature> {

    //~ Methods ----------------------------------------------------------------

    /**
     * DOCUMENT ME!
     *
     * @return  read-only view of all contained features
     */
    Collection<? extends Feature> getFeatures();

    /**
     * DOCUMENT ME!
     *
     * @param   toAdd  DOCUMENT ME!
     *
     * @return  DOCUMENT ME!
     */
    boolean addFeature(Feature toAdd);

    /**
     * DOCUMENT ME!
     *
     * @param   toAdd  DOCUMENT ME!
     *
     * @return  DOCUMENT ME!
     */
    boolean addFeatures(Collection<? extends Feature> toAdd);

    /**
     * DOCUMENT ME!
     *
     * @param   toRemove  DOCUMENT ME!
     *
     * @return  DOCUMENT ME!
     */
    boolean removeFeature(Feature toRemove);

    /**
     * DOCUMENT ME!
     *
     * @param   toRemove  DOCUMENT ME!
     *
     * @return  DOCUMENT ME!
     */
    boolean removeFeatures(Collection<? extends Feature> toRemove);
}