Mercurial > repos > IBBoard.WarFoundry.API
diff api/Factories/IWarFoundryFactory.cs @ 0:520818033bb6
Initial commit of WarFoundry code
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Fri, 19 Dec 2008 15:57:51 +0000 |
parents | |
children | 613bc5eaac59 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/api/Factories/IWarFoundryFactory.cs Fri Dec 19 15:57:51 2008 +0000 @@ -0,0 +1,52 @@ +// IWarFoundryFactory.cs +// +// Copyright (C) 2008 IBBoard +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library 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 +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// + +using System; +using System.IO; +using System.Collections.Generic; +using IBBoard.WarFoundry.API.Objects; + +namespace IBBoard.WarFoundry.API.Factories +{ + public interface IWarFoundryFactory + { + /// <summary> + /// Checks if the factory thinks it can handle the supplied file. Checks can be performed on file extension or some basic check of file content, or some other method. + /// </summary> + /// <param name="file"> + /// A <see cref="FileInfo"/> for the file to check support for. + /// </param> + /// <returns> + /// <code>true</code> if the file appears to be supported for loading by this factory, else returns <code>false</code> + /// </returns> + bool CanHandleFileFormat(FileInfo file); + + /// <summary> + /// Reads the data from the supplied file and returns it as a collection of loadable objects. + /// </summary> + /// <param name="file"> + /// A <see cref="FileInfo"/> for the file to load data from + /// </param> + /// <returns> + /// A <see cref="ICollection`1"/> of <see cref="IWarFoundryObject"/>s that were loaded from the file + /// </returns> + ICollection<IWarFoundryObject> CreateObjectsFromFile(FileInfo file); + } +}