.TH "zipios::FileEntry" 3 "Fri Aug 19 2016" "Zipios++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
zipios::FileEntry \- A \fBFileEntry\fP represents an entry in a \fBFileCollection\fP\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <fileentry\&.h>\fP
.PP
Inherited by \fBzipios::BasicEntry\fP, and \fBzipios::ZipLocalEntry\fP\&.
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBMatchFileName\fP"
.br
.RI "\fIFunction object to be used with the STL find_if algorithm to find a \fBFileEntry\fP in a container, which name (as obtained with \fBFileEntry::getFileName()\fP) is identical to the name specified in the \fBMatchName\fP constructor\&. \fP"
.ti -1c
.RI "class \fBMatchName\fP"
.br
.RI "\fIFunction object to be used with the STL find_if algorithm to find a \fBFileEntry\fP in a container, which name (as obtained with \fBFileEntry::getName()\fP) is identical to the name specified in the \fBMatchName\fP constructor\&. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual string \fBgetComment\fP () const =0"
.br
.RI "\fIReturns the comment of the entry, if it has one\&. \fP"
.ti -1c
.RI "virtual uint32 \fBgetCompressedSize\fP () const =0"
.br
.RI "\fIReturns the compressed size of the entry\&. \fP"
.ti -1c
.RI "virtual uint32 \fBgetCrc\fP () const =0"
.br
.RI "\fIReturns the Crc for the entry, if it has one\&. \fP"
.ti -1c
.RI "virtual vector< unsigned char > \fBgetExtra\fP () const =0"
.br
.RI "\fIReturns a vector of bytes of extra data that may be stored with the entry\&. \fP"
.ti -1c
.RI "virtual \fBStorageMethod\fP \fBgetMethod\fP () const =0"
.br
.RI "\fIReturns the method used to store the entry in the \fBFileCollection\fP\&. \fP"
.ti -1c
.RI "virtual string \fBgetName\fP () const =0"
.br
.RI "\fIReturns the full filename of the entry, including a path if the entry is stored in a subfolder\&. \fP"
.ti -1c
.RI "virtual string \fBgetFileName\fP () const =0"
.br
.RI "\fIReturns the filename of the entry\&. \fP"
.ti -1c
.RI "virtual uint32 \fBgetSize\fP () const =0"
.br
.RI "\fIReturns the (uncompressed) size of the entry data\&. \fP"
.ti -1c
.RI "virtual int \fBgetTime\fP () const =0"
.br
.RI "\fIReturns the date and time of FIXME: what? \fP"
.ti -1c
.RI "virtual bool \fBisValid\fP () const =0"
.br
.RI "\fIAny method or operator that initializes a \fBFileEntry\fP may set a flag, that specifies whether the read entry is valid or not\&. \fP"
.ti -1c
.RI "virtual bool \fBisDirectory\fP () const =0"
.br
.RI "\fIReturns true if the entry is a directory\&. \fP"
.ti -1c
.RI "virtual void \fBsetComment\fP (const string &comment)=0"
.br
.RI "\fISets the comment field for the \fBFileEntry\fP\&. \fP"
.ti -1c
.RI "virtual void \fBsetCompressedSize\fP (uint32 size)=0"
.br
.RI "\fISet the compressed size field of the entry\&. \fP"
.ti -1c
.RI "virtual void \fBsetCrc\fP (uint32 crc)=0"
.br
.RI "\fISets the crc field\&. \fP"
.ti -1c
.RI "virtual void \fBsetExtra\fP (const vector< unsigned char > &extra)=0"
.br
.RI "\fISets the extra field\&. \fP"
.ti -1c
.RI "virtual void \fBsetMethod\fP (\fBStorageMethod\fP method)=0"
.br
.RI "\fISets the storage method field for the entry\&. \fP"
.ti -1c
.RI "virtual void \fBsetName\fP (const string &name)=0"
.br
.RI "\fISets the name field for the entry\&. \fP"
.ti -1c
.RI "virtual void \fBsetSize\fP (uint32 size)=0"
.br
.RI "\fISets the size field for the entry\&. \fP"
.ti -1c
.RI "virtual void \fBsetTime\fP (int time)=0"
.br
.RI "\fISets the time field for the entry\&. \fP"
.ti -1c
.RI "virtual string \fBtoString\fP () const =0"
.br
.RI "\fIReturns a human-readable string representation of the entry\&. \fP"
.ti -1c
.RI "virtual \fBFileEntry\fP * \fBclone\fP () const =0"
.br
.RI "\fICreate a heap allocated clone of the object this method is called for\&. \fP"
.ti -1c
.RI "virtual \fB~FileEntry\fP ()"
.br
.RI "\fI\fBFileEntry\fP destructor\&. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBref\fP () const "
.br
.ti -1c
.RI "unsigned int \fBunref\fP () const "
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBReferenceCount\fP< \fBFileEntry\fP > \fB_refcount\fP"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBSimpleSmartPointer< FileEntry >\fP"
.br
.ti -1c
.RI "class \fBSimpleSmartPointer< const FileEntry >\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A \fBFileEntry\fP represents an entry in a \fBFileCollection\fP\&. 

The interface is a copy of the ZipEntry interface from the java\&.util\&.zip package\&. The name has been changed to \fBFileEntry\fP, as \fBFileCollection\fP is a more general abstraction, that covers other types of file collections than just zip files\&. 
.PP
Definition at line 52 of file fileentry\&.h\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "virtual zipios::FileEntry::~FileEntry ()\fC [inline]\fP, \fC [virtual]\fP"

.PP
\fBFileEntry\fP destructor\&. 
.PP
Definition at line 163 of file fileentry\&.h\&.
.SH "Member Function Documentation"
.PP 
.SS "virtual \fBFileEntry\fP* zipios::FileEntry::clone () const\fC [pure virtual]\fP"

.PP
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\&. 
.PP
\fBReturns:\fP
.RS 4
A heap allocated copy of the object this method is called for\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipCDirEntry\fP, \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual string zipios::FileEntry::getComment () const\fC [pure virtual]\fP"

.PP
Returns the comment of the entry, if it has one\&. Otherwise it returns an empty string\&. 
.PP
\fBReturns:\fP
.RS 4
the comment associated with the entry, if there is one\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipCDirEntry\fP, \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual uint32 zipios::FileEntry::getCompressedSize () const\fC [pure virtual]\fP"

.PP
Returns the compressed size of the entry\&. If the entry is not stored in a compressed format, the uncompressed size is returned\&. 
.PP
\fBReturns:\fP
.RS 4
the compressed size of the entry\&. If the entry is stored without compression the uncompressed size is returned\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual uint32 zipios::FileEntry::getCrc () const\fC [pure virtual]\fP"

.PP
Returns the Crc for the entry, if it has one\&. FIXME: what is returned if it doesn't have one? 
.PP
\fBReturns:\fP
.RS 4
the Crc for the entry, if it has one\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual vector< unsigned char > zipios::FileEntry::getExtra () const\fC [pure virtual]\fP"

.PP
Returns a vector of bytes of extra data that may be stored with the entry\&. 
.PP
\fBReturns:\fP
.RS 4
A vector< unsigned char > of extra bytes that may potentially be associated with an entry\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual string zipios::FileEntry::getFileName () const\fC [pure virtual]\fP"

.PP
Returns the filename of the entry\&. 
.PP
\fBReturns:\fP
.RS 4
Returns the filename of the entry\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual \fBStorageMethod\fP zipios::FileEntry::getMethod () const\fC [pure virtual]\fP"

.PP
Returns the method used to store the entry in the \fBFileCollection\fP\&. 
.PP
\fBReturns:\fP
.RS 4
the storage method used to store the entry in the collection\&. 
.RE
.PP
\fBSee also:\fP
.RS 4
StorageMethod\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual string zipios::FileEntry::getName () const\fC [pure virtual]\fP"

.PP
Returns the full filename of the entry, including a path if the entry is stored in a subfolder\&. 
.PP
\fBReturns:\fP
.RS 4
the filename of the entry, including path if the entry is stored in a sub-folder\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual uint32 zipios::FileEntry::getSize () const\fC [pure virtual]\fP"

.PP
Returns the (uncompressed) size of the entry data\&. 
.PP
\fBReturns:\fP
.RS 4
Returns the (uncompressed) size of the entry\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual int zipios::FileEntry::getTime () const\fC [pure virtual]\fP"

.PP
Returns the date and time of FIXME: what? 
.PP
\fBReturns:\fP
.RS 4
the date and time of the entry\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual bool zipios::FileEntry::isDirectory () const\fC [pure virtual]\fP"

.PP
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\&. 
.PP
\fBReturns:\fP
.RS 4
true if the entry is a directory\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual bool zipios::FileEntry::isValid () const\fC [pure virtual]\fP"

.PP
Any method or operator that initializes a \fBFileEntry\fP may set a flag, that specifies whether the read entry is valid or not\&. If it isn't this method returns false\&. 
.PP
\fBReturns:\fP
.RS 4
true if the \fBFileEntry\fP has been parsed succesfully\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual void zipios::FileEntry::setComment (const string & comment)\fC [pure virtual]\fP"

.PP
Sets the comment field for the \fBFileEntry\fP\&. 
.PP
\fBParameters:\fP
.RS 4
\fIcomment\fP string with the new comment\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipCDirEntry\fP, \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual void zipios::FileEntry::setCompressedSize (uint32 size)\fC [pure virtual]\fP"

.PP
Set the compressed size field of the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP value to set the compressed size field of the entry to\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual void zipios::FileEntry::setCrc (uint32 crc)\fC [pure virtual]\fP"

.PP
Sets the crc field\&. 
.PP
\fBParameters:\fP
.RS 4
\fIcrc\fP value to set the crc field to\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual void zipios::FileEntry::setExtra (const vector< unsigned char > & extra)\fC [pure virtual]\fP"

.PP
Sets the extra field\&. 
.PP
\fBParameters:\fP
.RS 4
\fIextra\fP the extra field is set to this value\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual void zipios::FileEntry::setMethod (\fBStorageMethod\fP method)\fC [pure virtual]\fP"

.PP
Sets the storage method field for the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fImethod\fP the method field is set to the specified value\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual void zipios::FileEntry::setName (const string & name)\fC [pure virtual]\fP"

.PP
Sets the name field for the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP the name field is set to the specified value\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual void zipios::FileEntry::setSize (uint32 size)\fC [pure virtual]\fP"

.PP
Sets the size field for the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP the size field is set to this value\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual void zipios::FileEntry::setTime (int time)\fC [pure virtual]\fP"

.PP
Sets the time field for the entry\&. 
.PP
\fBParameters:\fP
.RS 4
\fItime\fP the time field is set to the specified value\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.
.SS "virtual string zipios::FileEntry::toString () const\fC [pure virtual]\fP"

.PP
Returns a human-readable string representation of the entry\&. 
.PP
\fBReturns:\fP
.RS 4
a human-readable string representation of the entry\&. 
.RE
.PP

.PP
Implemented in \fBzipios::ZipCDirEntry\fP, \fBzipios::ZipLocalEntry\fP, and \fBzipios::BasicEntry\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Zipios++ from the source code\&.