FileStreamFactory.h 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. //
  2. // FileStreamFactory.h
  3. //
  4. // $Id: //poco/svn/Foundation/include/Poco/FileStreamFactory.h#2 $
  5. //
  6. // Library: Foundation
  7. // Package: URI
  8. // Module: FileStreamFactory
  9. //
  10. // Definition of the FileStreamFactory class.
  11. //
  12. // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
  13. // and Contributors.
  14. //
  15. // Permission is hereby granted, free of charge, to any person or organization
  16. // obtaining a copy of the software and accompanying documentation covered by
  17. // this license (the "Software") to use, reproduce, display, distribute,
  18. // execute, and transmit the Software, and to prepare derivative works of the
  19. // Software, and to permit third-parties to whom the Software is furnished to
  20. // do so, all subject to the following:
  21. //
  22. // The copyright notices in the Software and this entire statement, including
  23. // the above license grant, this restriction and the following disclaimer,
  24. // must be included in all copies of the Software, in whole or in part, and
  25. // all derivative works of the Software, unless such copies or derivative
  26. // works are solely in the form of machine-executable object code generated by
  27. // a source language processor.
  28. //
  29. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  30. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  31. // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
  32. // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
  33. // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
  34. // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  35. // DEALINGS IN THE SOFTWARE.
  36. //
  37. #ifndef Foundation_FileStreamFactory_INCLUDED
  38. #define Foundation_FileStreamFactory_INCLUDED
  39. #include "Poco/Foundation.h"
  40. #include "Poco/URIStreamFactory.h"
  41. namespace Poco {
  42. class Path;
  43. class Foundation_API FileStreamFactory: public URIStreamFactory
  44. /// An implementation of the URIStreamFactory interface
  45. /// that handles file URIs.
  46. {
  47. public:
  48. FileStreamFactory();
  49. /// Creates the FileStreamFactory.
  50. ~FileStreamFactory();
  51. /// Destroys the FileStreamFactory.
  52. std::istream* open(const URI& uri);
  53. /// Creates and opens a file stream in binary mode for the given URI.
  54. /// The URI must be either a file URI or a relative URI reference
  55. /// containing a path to a local file.
  56. ///
  57. /// Throws an FileNotFound exception if the file cannot
  58. /// be opened.
  59. std::istream* open(const Path& path);
  60. /// Creates and opens a file stream in binary mode for the given path.
  61. ///
  62. /// Throws an FileNotFound exception if the file cannot
  63. /// be opened.
  64. };
  65. } // namespace Poco
  66. #endif // Foundation_FileStreamFactory_INCLUDED