#include <fileentry.h>
Inherited by zipios::BasicEntry, and zipios::ZipLocalEntry.
virtual string getComment () const =0
Returns the comment of the entry, if it has one.
virtual uint32 getCompressedSize () const =0
Returns the compressed size of the entry.
virtual uint32 getCrc () const =0
Returns the Crc for the entry, if it has one.
virtual vector< unsigned char > getExtra () const =0
Returns a vector of bytes of extra data that may be stored with the entry.
virtual StorageMethod getMethod () const =0
Returns the method used to store the entry in the FileCollection.
virtual string getName () const =0
Returns the full filename of the entry, including a path if the entry is stored in a subfolder.
virtual string getFileName () const =0
Returns the filename of the entry.
virtual uint32 getSize () const =0
Returns the (uncompressed) size of the entry data.
virtual int getTime () const =0
Returns the date and time of FIXME: what?
virtual bool isValid () const =0
Any method or operator that initializes a FileEntry may set a flag, that specifies whether the read entry is valid or not.
virtual bool isDirectory () const =0
Returns true if the entry is a directory.
virtual void setComment (const string &comment)=0
Sets the comment field for the FileEntry.
virtual void setCompressedSize (uint32 size)=0
Set the compressed size field of the entry.
virtual void setCrc (uint32 crc)=0
Sets the crc field.
virtual void setExtra (const vector< unsigned char > &extra)=0
Sets the extra field.
virtual void setMethod (StorageMethod method)=0
Sets the storage method field for the entry.
virtual void setName (const string &name)=0
Sets the name field for the entry.
virtual void setSize (uint32 size)=0
Sets the size field for the entry.
virtual void setTime (int time)=0
Sets the time field for the entry.
virtual string toString () const =0
Returns a human-readable string representation of the entry.
virtual FileEntry * clone () const =0
Create a heap allocated clone of the object this method is called for.
virtual ~FileEntry ()
FileEntry destructor.
void ref () const
unsigned int unref () const
ReferenceCount< FileEntry > _refcount
class SimpleSmartPointer< FileEntry >
class SimpleSmartPointer< const FileEntry >
class MatchFileName
Function object to be used with the STL find_if algorithm to find a FileEntry in a container, which name (as obtained with FileEntry::getFileName()) is identical to the name specified in the MatchName constructor.
class MatchName
Function object to be used with the STL find_if algorithm to find a FileEntry in a container, which name (as obtained with FileEntry::getName()) is identical to the name specified in the MatchName constructor.
A FileEntry represents an entry in a FileCollection.
The interface is a copy of the ZipEntry interface from the java.util.zip package. The name has been changed to FileEntry, as FileCollection is a more general abstraction, that covers other types of file collections than just zip files.
Definition at line 52 of file fileentry.h.
FileEntry destructor.
Definition at line 163 of file fileentry.h.
Returns the comment of the entry, if it has one.
Otherwise it returns an empty string.
Returns:
Implemented in zipios::BasicEntry, zipios::ZipLocalEntry, and zipios::ZipCDirEntry.
Returns the compressed size of the entry.
If the entry is not stored in a compressed format, the uncompressed size is returned.
Returns:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Returns the Crc for the entry, if it has one.
FIXME: what is returned if it doesn't have one?
Returns:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Returns a vector of bytes of extra data that may be stored with the entry.
Returns:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Returns the method used to store the entry in the FileCollection.
Returns:
See also:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Returns the full filename of the entry, including a path if the entry is stored in a subfolder.
Returns:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Returns the filename of the entry.
Returns:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Returns the (uncompressed) size of the entry data.
Returns:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Returns the date and time of FIXME: what?
Returns:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Any method or operator that initializes a FileEntry may set a flag, that specifies whether the read entry is valid or not.
If it isn't this method returns false.
Returns:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Returns true if the entry is a directory.
A directory entry is an entry which name ends with a separator ('/' for Unix systems, '\' for Windows and DOS systems.
Returns:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Sets the comment field for the FileEntry.
Parameters:
Implemented in zipios::BasicEntry, zipios::ZipLocalEntry, and zipios::ZipCDirEntry.
Set the compressed size field of the entry.
Parameters:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Sets the crc field.
Parameters:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Sets the extra field.
Parameters:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Sets the storage method field for the entry.
Parameters:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Sets the name field for the entry.
Parameters:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Sets the size field for the entry.
Parameters:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Sets the time field for the entry.
Parameters:
Implemented in zipios::BasicEntry, and zipios::ZipLocalEntry.
Returns a human-readable string representation of the entry.
Returns:
Implemented in zipios::BasicEntry, zipios::ZipLocalEntry, and zipios::ZipCDirEntry.
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:
Implemented in zipios::BasicEntry, zipios::ZipLocalEntry, and zipios::ZipCDirEntry.
Generated automatically by Doxygen for Zipios++ from the source code.