Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.util;

import java.util.List;

import org.gvsig.tools.exception.ListBaseException;

/**

 * 

 * This is a utility class for call a list of callables.

 * 

 * It can collect exceptions and continue to call the next 

 * callable in the list. 

 * 

 * @author gvSIG Team - jjdelcerro

 *

 */

public interface Caller {

        /**

         * Get if the Caller can collect exceptions or

         * exit in the first exception produced.

         * 

         * @return boolean that indicate that collect exceptions.

         */

        public boolean getCollectExceptions();

        /**

         * Set in the caller the behabior of collect al exceptions

         * and continue calling the next callable in the list of our

         * callables.

         * 

         * @param collectExceptions

         */

        public void setCollectExceptions(boolean collectExceptions);

        /**

         * Add a callable to the list of callables of the caller.

         * @param callable

         */

        public void add(Callable callable);

        /**

         * Return the list of collected exceptions or null.

         * 

         * @return list of exceptions

         */

        public List getExceptions();

        /**

         * Return the collected exceptions as a ListBaseException or null.

         * 

         * @return list of exceptions

         */

        public ListBaseException getException();

        /**

         * Call all callables in the list of callables of the caller.

         * 

         * @return true if no exceptions produced

         */

        public boolean call();

}