zipios::FileCollection

       Generated automatically by Doxygen for Zipios++ from the source code.

Zipios++                                         Tue Mar 24 2020                       zipios::FileCollection(3)

zipios::FileCollection::FileCollection()[inline],[explicit]FileCollection constructor.

       Definition at line 24 of file fcoll.h.

   zipios::FileCollection::FileCollection(constFileCollection&src)[inline]
       Copy constructor.

       Definition at line 115 of file fcoll.h.

   zipios::FileCollection::~FileCollection()[virtual]FileCollection destructor.

       Definition at line 63 of file fcoll.cpp.

FileCollection is an abstract baseclass that represents a collection of files. The specializations of
       FileCollection represents different origins of file collections, such as directories, simple filename
       lists and compressed archives.

       Definition at line 21 of file fcoll.h.

virtualFileCollection*zipios::FileCollection::clone()const[purevirtual]
       Create a heap allocated clone of the object this method is called for. The caller is responsible for
       deallocating the clone when he is done with it.

       Returns
           A heap allocated copy of the object this method is called for.

       Implemented in zipios::CollectionCollection, zipios::ZipFile, and zipios::DirectoryCollection.

   virtualvoidzipios::FileCollection::close()[purevirtual]
       Closes the FileCollection.

       Implemented in zipios::CollectionCollection, zipios::ZipFile, and zipios::DirectoryCollection.

   ConstEntrieszipios::FileCollection::entries()const[virtual]
       Returns a vector of const pointers to the entries in the FileCollection.

       Returns
           a ConstEntries containing the entries of the FileCollection.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Reimplemented in zipios::CollectionCollection, and zipios::DirectoryCollection.

       Definition at line 17 of file fcoll.cpp.

   ConstEntryPointerzipios::FileCollection::getEntry(conststring&name,MatchPathmatchpath=MATCH)const[virtual]
       Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name. To ignore the
       path part of the filename in search of a match, specify FileCollection::IGNORE as the second argument.

       Parametersname A string containing the name of the entry to get.
           matchpath Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be
           ignored.

       Returns
           A ConstEntryPointer to the found entry. The returned pointer equals zero if no entry is found.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Reimplemented in zipios::CollectionCollection, and zipios::DirectoryCollection.

       Definition at line 34 of file fcoll.cpp.

   virtualistream*zipios::FileCollection::getInputStream(constConstEntryPointer&entry)[purevirtual]
       Returns a pointer to an opened istream for the specified FileEntry. It is the callers responsibility to
       delete the stream when he is done with it. Returns 0, if there is no such FileEntry in the
       FileCollection.

       Parametersentry A ConstEntryPointer to the FileEntry to get an istream to.

       Returns
           an open istream for the specified entry. The istream is allocated on heap and it is the users
           responsibility to delete it when he is done with it.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Implemented in zipios::CollectionCollection, zipios::ZipFile, and zipios::DirectoryCollection.

   virtualistream*zipios::FileCollection::getInputStream(conststring&entry_name,MatchPathmatchpath=MATCH)[purevirtual]
       Returns a pointer to an opened istream for the specified entry name. It is the callers responsibility to
       delete the stream when he is done with it. Returns 0, if there is no entry with the specified name in the
       FileCollection.

       Parametersmatchpath Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be
           ignored.

       Returns
           an open istream for the specified entry. The istream is allocated on heap and it is the users
           responsibility to delete it when he is done with it.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Implemented in zipios::CollectionCollection, zipios::ZipFile, and zipios::DirectoryCollection.

   stringzipios::FileCollection::getName()const[virtual]
       Returns the name of the FileCollection.

       Returns
           the name of the FileCollection.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Definition at line 50 of file fcoll.cpp.

   boolzipios::FileCollection::isValid()const[inline]
       The member function returns true if the collection is valid.

       Returns
           true if the collection is valid.

       Definition at line 93 of file fcoll.h.

   constFileCollection&zipios::FileCollection::operator=(constFileCollection&src)[inline]
       Copy assignment operator.

       Definition at line 125 of file fcoll.h.

   intzipios::FileCollection::size()const[virtual]
       Returns the number of entries in the FileCollection.

       Returns
           the number of entries in the FileCollection.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Reimplemented in zipios::CollectionCollection, and zipios::DirectoryCollection.

       Definition at line 57 of file fcoll.cpp.

       zipios::FileCollection

       #include <fcoll.h>

       Inherited by zipios::CollectionCollection, zipios::DirectoryCollection, and zipios::ZipFile.

   PublicTypes
       enum MatchPath { IGNORE, MATCH }

   PublicMemberFunctionsFileCollection ()
           FileCollection constructor.
       FileCollection (const FileCollection &src)
           Copy constructor.
       const FileCollection & operator= (const FileCollection &src)
           Copy assignment operator.
       virtual void close ()=0
           Closes the FileCollection.
       virtual ConstEntriesentries () const
       virtual ConstEntryPointergetEntry (const string &name, MatchPath matchpath=MATCH) const
       virtual istream * getInputStream (const ConstEntryPointer &entry)=0
       virtual istream * getInputStream (const string &entry_name, MatchPath matchpath=MATCH)=0
           Returns a pointer to an opened istream for the specified entry name.
       virtual string getName () const
           Returns the name of the FileCollection.
       virtual int size () const
           Returns the number of entries in the FileCollection.
       bool isValid () const
           The member function returns true if the collection is valid.
       virtual FileCollection * clone () const =0
           Create a heap allocated clone of the object this method is called for.
       virtual ~FileCollection ()
           FileCollection destructor.

   ProtectedAttributes
       string _filenameEntries_entries
       bool _valid