IMapLister.java

/*******************************************************************************
 * Copyright (c) 2015
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *******************************************************************************/
package jsettlers.logic.map.loading.list;

import java.io.IOException;
import java.io.OutputStream;

import jsettlers.logic.map.loading.newmap.MapFileHeader;

public interface IMapLister {
	public interface IMapListerCallable {
		void foundMap(IListedMap map);
	}

	void listMaps(IMapListerCallable callable);

	/**
	 * Gets an output stream that can be used to store the map. The stream is to a file with a nice name and does not override any other file.
	 * 
	 * @param header
	 *            The header to create the file name from. It is not written to the stream.
	 * @return A output stream to a fresh generated file.
	 * @throws IOException
	 */
	OutputStream getOutputStream(MapFileHeader header) throws IOException;
}