// This file (ILoadableObject.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2012 IBBoard
//
// The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.
using System;
using System.IO;

namespace IBBoard.WarFoundry.API.Loading
{
	/// <summary>
	/// Interface for objects that are the source of WarFoundryObjects that can be loaded by a Factory.
	/// Examples include files and streams.
	/// </summary>
	public interface ILoadableObject
	{
		string Name { get; }

		/// <summary>
		/// Gets the stream for the loadable object that the WarFoundryObject can be loaded from. This stream will be
		/// created each time the method is called and must be disposed of by the calling function.
		/// </summary>
		/// <returns>
		/// The stream for the source.
		/// </returns>
		Stream GetStream();
	}
}