BackupResourceIterable.java

/* ==================================================================
 * BackupResourceIterable.java - Mar 27, 2013 4:52:45 PM
 * 
 * Copyright 2007-2013 SolarNetwork.net Dev Team
 * 
 * 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 2 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., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ==================================================================
 */

package net.solarnetwork.node.backup;

import java.io.Closeable;
import java.util.Iterator;

/**
 * An iterator over backup resources.
 * 
 * <p>
 * This iterator must be closed when finished using it, to correctly free up any
 * internal resources used by the instance. Once closed, {@link #iterator()}
 * should not be used again, and any {@link BackupResoruce} instanced returned
 * by any previously obtained {@link Iterator} instances are not considered
 * valid.
 * </p>
 * 
 * @author matt
 * @version 1.0
 */
public interface BackupResourceIterable extends Iterable<BackupResource>, Closeable {

}