Common::GenericArchiveMember Class Reference

#include <archive.h>

Inheritance diagram for Common::GenericArchiveMember:

Public Member Functions
	GenericArchiveMember (const Common::String &pathStr, const Archive &parent)
	GenericArchiveMember (const Common::Path &path, const Archive &parent)
String	getName () const override
Path	getPathInArchive () const override
String	getFileName () const override
SeekableReadStream *	createReadStream () const override
SeekableReadStream *	createReadStreamForAltStream (AltStreamType altStreamType) const override
bool	isDirectory () const override
void	listChildren (ArchiveMemberList &childList, const char *pattern) const override
Public Member Functions inherited from Common::ArchiveMember
virtual SeekableReadStream *	createReadStream () const =0
virtual SeekableReadStream *	createReadStreamForAltStream (AltStreamType altStreamType) const =0
virtual String	getName () const =0
virtual Path	getPathInArchive () const =0
virtual String	getFileName () const =0
virtual bool	isDirectory () const
virtual void	listChildren (ArchiveMemberList &childList, const char *pattern=nullptr) const
virtual U32String	getDisplayName () const
virtual bool	isInMacArchive () const

Detailed Description

Simple ArchiveMember implementation which allows creation of ArchiveMember compatible objects via a simple Archive and name pair.

Note that GenericArchiveMember objects will not be working anymore after the 'parent' object is destroyed.

Constructor & Destructor Documentation

GenericArchiveMember() [1/2]

Common::GenericArchiveMember::GenericArchiveMember	(	const Common::String &	pathStr,
		const Archive &	parent
	)

Create a generic archive member that belongs to the parent archive.

GenericArchiveMember() [2/2]

Common::GenericArchiveMember::GenericArchiveMember	(	const Common::Path &	path,
		const Archive &	parent
	)

Create a generic archive member that belongs to the parent archive.

Member Function Documentation

getName()

String Common::GenericArchiveMember::getName ( ) const

overridevirtual

Get the name of a generic archive member.

Implements Common::ArchiveMember.

getPathInArchive()

Path Common::GenericArchiveMember::getPathInArchive ( ) const

overridevirtual

Get the full path of the archive member relative to the containing archive root.

Implements Common::ArchiveMember.

getFileName()

String Common::GenericArchiveMember::getFileName ( ) const

overridevirtual

Get the file name of the archive member relative to its containing directory within the archive.

Implements Common::ArchiveMember.

createReadStream()

SeekableReadStream * Common::GenericArchiveMember::createReadStream ( ) const

overridevirtual

Create a read stream.

Implements Common::ArchiveMember.

createReadStreamForAltStream()

SeekableReadStream * Common::GenericArchiveMember::createReadStreamForAltStream ( AltStreamType  altStreamType ) const

overridevirtual

Create a read stream of an alternate stream.

Implements Common::ArchiveMember.

isDirectory()

bool Common::GenericArchiveMember::isDirectory ( ) const

overridevirtual

Checks if the ArchiveMember is a directory.

Reimplemented from Common::ArchiveMember.

listChildren()

void Common::GenericArchiveMember::listChildren ( ArchiveMemberList &  childList, const char *  pattern  ) const

overridevirtual

Adds the immediate children of this archive member to childList, optionally matching a pattern.

Reimplemented from Common::ArchiveMember.

---

The documentation for this class was generated from the following file:

• common/archive.h