Apache log4cxx  Version 0.10.0
File Class Reference

An abstract representation of file and directory path names. More...

List of all members.

Public Member Functions

 File ()
 Construct a new instance.
 File (const char *path)
 Construct a new instance.
 File (const std::string &path)
 Construct a new instance.
 File (const wchar_t *path)
 Construct a new instance.
 File (const std::wstring &path)
 Construct a new instance.
 File (const UniChar *path)
 Construct a new instance.
 File (const std::basic_string< UniChar > &path)
 Construct a new instance.
 File (const CFStringRef &path)
 Construct a new instance.
 File (const File &src)
 Copy constructor.
Fileoperator= (const File &src)
 Assignment operator.
 ~File ()
 Destructor.
bool exists (log4cxx::helpers::Pool &p) const
 Determines if file exists.
size_t length (log4cxx::helpers::Pool &p) const
 Determines length of file.
log4cxx_time_t lastModified (log4cxx::helpers::Pool &p) const
 Determines last modification date.
LogString getName () const
 Get final portion of file path.
LogString getPath () const
 Get file path.
FilesetPath (const LogString &)
 Set file path.
log4cxx_status_t open (apr_file_t **file, int flags, int perm, log4cxx::helpers::Pool &p) const
 Open file.
std::vector< LogStringlist (log4cxx::helpers::Pool &p) const
 List files if current file is a directory.
bool deleteFile (log4cxx::helpers::Pool &p) const
 Delete file.
bool renameTo (const File &dest, log4cxx::helpers::Pool &p) const
 Rename file.
LogString getParent (log4cxx::helpers::Pool &p) const
 Get path of parent directory.
bool mkdirs (log4cxx::helpers::Pool &p) const
 Make directories recursively.

Detailed Description

An abstract representation of file and directory path names.


Constructor & Destructor Documentation

File ( )

Construct a new instance.

File ( const char *  path)

Construct a new instance.

Use setPath to specify path using a LogString.

Parameters:
pathfile path in local encoding.
File ( const std::string &  path)

Construct a new instance.

Use setPath to specify path using a LogString.

Parameters:
pathfile path in current encoding.
File ( const wchar_t *  path)

Construct a new instance.

Use setPath to specify path using a LogString.

Parameters:
pathfile path.
File ( const std::wstring &  path)

Construct a new instance.

Use setPath to specify path using a LogString.

Parameters:
pathfile path.
File ( const UniChar path)

Construct a new instance.

Use setPath to specify path using a LogString.

Parameters:
pathfile path.
File ( const std::basic_string< UniChar > &  path)

Construct a new instance.

Use setPath to specify path using a LogString.

Parameters:
pathfile path.
File ( const CFStringRef path)

Construct a new instance.

Use setPath to specify path using a LogString.

Parameters:
pathfile path.
File ( const File src)

Copy constructor.

~File ( )

Destructor.


Member Function Documentation

bool deleteFile ( log4cxx::helpers::Pool p) const

Delete file.

Parameters:
ppool.
Returns:
true if file successfully deleted.
bool exists ( log4cxx::helpers::Pool p) const

Determines if file exists.

Parameters:
ppool.
Returns:
true if file exists.
LogString getName ( ) const

Get final portion of file path.

Returns:
file name.

Get path of parent directory.

Parameters:
ppool.
Returns:
path of parent directory.
LogString getPath ( ) const

Get file path.

Returns:
file path.

Determines last modification date.

Parameters:
ppool.
Returns:
length of file.
size_t length ( log4cxx::helpers::Pool p) const

Determines length of file.

May not be accurate if file is current open.

Parameters:
ppool.
Returns:
length of file.
std::vector<LogString> list ( log4cxx::helpers::Pool p) const

List files if current file is a directory.

Parameters:
ppool.
Returns:
list of files in this directory, operation of non-directory returns empty list.
bool mkdirs ( log4cxx::helpers::Pool p) const

Make directories recursively.

Parameters:
ppool.
Returns:
true if all requested directories existed or have been created.
log4cxx_status_t open ( apr_file_t **  file,
int  flags,
int  perm,
log4cxx::helpers::Pool p 
) const

Open file.

See apr_file_open for details.

Parameters:
fileAPR file handle.
flagsflags.
permpermissions.
ppool.
Returns:
APR_SUCCESS if successful.
File& operator= ( const File src)

Assignment operator.

bool renameTo ( const File dest,
log4cxx::helpers::Pool p 
) const

Rename file.

Parameters:
destnew path for file.
ppool.
Returns:
true if file successfully renamed.
File& setPath ( const LogString )

Set file path.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines