Mercurial > repos > IBBoard.WarFoundry.API
view api/Factories/IWarFoundryFactory.cs @ 14:0770e5cbba7c
Closes #21 - File loading in order
* Reworked LoadFiles to smaller methods for readability (also re #10) and structure
* Now determine expected load return before loading then load all "expected GameSystem" before "expected Race"
* Make "can load as race/game system/army" methods public in interface
Re #22 - Get errored file loading
* Created FileLoadFailure class and made LoadFiles return a list of them
Also
* Some code cleanup
* Change to DictionaryUtils calls
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Sun, 25 Jan 2009 14:03:20 +0000 |
parents | 613bc5eaac59 |
children | 306558904c2a |
line wrap: on
line source
// 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> /// Completes the loading of an object if it is loaded in stages. /// </summary> /// <param name="obj"> /// The <see cref="IWarFoundryStagedLoadObject"/> that should be fully loaded. /// </param> void CompleteLoading(IWarFoundryStagedLoadObject obj); /// <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> /// Checks if the factory thinks it can handle the supplied file as a Race. 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 as a file containing Race information. /// </param> /// <returns> /// <code>true</code> if the file appears to be supported for loading by this factory as a Race, else returns <code>false</code> /// </returns> bool CanHandleFileAsRace(FileInfo file); /// <summary> /// Checks if the factory thinks it can handle the supplied file as a GameSystem. 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 as a file containing GameSystem information. /// </param> /// <returns> /// <code>true</code> if the file appears to be supported for loading by this factory as a GameSystem, else returns <code>false</code> /// </returns> bool CanHandleFileAsGameSystem(FileInfo file); /// <summary> /// Checks if the factory thinks it can handle the supplied file as a Army. 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 as a file containing Army information. /// </param> /// <returns> /// <code>true</code> if the file appears to be supported for loading by this factory as a Army, else returns <code>false</code> /// </returns> bool CanHandleFileAsArmy(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); } }