file Class Reference

#include <file.hpp>

Inheritance diagram for file:

Collaboration diagram for file:

Public Types
typedef utility::path	path
typedef unsigned long	length_type

Public Member Functions
virtual	~file ()
virtual void	createFile ()=0
virtual void	createDirectory (const bool createAll=false)=0
virtual bool	isFile () const =0
virtual bool	isDirectory () const =0
virtual bool	canRead () const =0
virtual bool	canWrite () const =0
virtual length_type	getLength ()=0
virtual const path &	getFullPath () const =0
virtual bool	exists () const =0
virtual shared_ptr< file >	getParent () const =0
virtual void	rename (const path &newName)=0
virtual void	remove ()=0
virtual shared_ptr< fileWriter >	getFileWriter ()=0
virtual shared_ptr< fileReader >	getFileReader ()=0
virtual shared_ptr< fileIterator >	getFiles () const =0

Protected Member Functions
	file ()
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

Abstract representation of a file or directory.

Member Typedef Documentation

length_type

typedef unsigned long length_type

path

typedef utility::path path

Constructor & Destructor Documentation

~file()

virtual ~file ( )

virtual

file()

file ( )

protected

Member Function Documentation

canRead()

virtual bool canRead ( ) const

pure virtual

Test whether this file is readible.

Returns

true if we can read this file, false otherwise

canWrite()

virtual bool canWrite ( ) const

pure virtual

Test whether this file is writeable.

Returns

true if we can write to this file, false otherwise

createDirectory()

virtual void createDirectory ( const bool  createAll = false )

pure virtual

Create the directory pointed by this file object.

Parameters

createAll

if set to true, recursively create all parent directories if they do not exist

Exceptions

exceptions::filesystem_exception

if an error occurs

createFile()

virtual void createFile ( )

pure virtual

Create the file pointed by this file object.

Exceptions

exceptions::filesystem_exception

if an error occurs

exists()

virtual bool exists ( ) const

pure virtual

Test whether this file/directory exists.

Returns

true if the file exists, false otherwise

getFileReader()

virtual shared_ptr< fileReader > getFileReader ( )

pure virtual

Return an object capable of reading from this file.

Returns

file reader object

getFiles()

virtual shared_ptr< fileIterator > getFiles ( ) const

pure virtual

Enumerate files contained in this directory.

Returns

file iterator to enumerate files

Exceptions

exceptions::not_a_directory

if this is not a directory, exceptions::filesystem_exception if another error occurs

getFileWriter()

virtual shared_ptr< fileWriter > getFileWriter ( )

pure virtual

Return an object capable of writing to this file.

Returns

file writer object

getFullPath()

virtual const path & getFullPath ( ) const

pure virtual

Return the full path of this file/directory.

Returns

full path of the file

Referenced by courierMaildirFormat::isSubfolderDirectory(), and kmailMaildirFormat::isSubfolderDirectory().

getLength()

virtual length_type getLength ( )

pure virtual

Return the length of this file.

Returns

file size (in bytes)

getParent()

virtual shared_ptr< file > getParent ( ) const

pure virtual

Return the parent directory of this file/directory.

Returns

parent directory (or NULL if root)

isDirectory()

virtual bool isDirectory ( ) const

pure virtual

Test whether this is a directory.

Returns

true if this is a directory, false otherwise

Referenced by courierMaildirFormat::isSubfolderDirectory(), and kmailMaildirFormat::isSubfolderDirectory().

isFile()

virtual bool isFile ( ) const

pure virtual

Test whether this is a file.

Returns

true if this is a file, false otherwise

remove()

virtual void remove ( )

pure virtual

Deletes this file/directory.

If this is a directory, it must be empty.

Exceptions

exceptions::filesystem_exception

if an error occurs

rename()

virtual void rename ( const path &  newName )

pure virtual

Rename the file/directory.

Parameters

newName

full path of the new file

Exceptions

exceptions::filesystem_exception

if an error occurs

---

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

• file.hpp