Lucene++ - a full-featured, c++ search engine
API Documentation


Functions
Lucene::FileUtils Namespace Reference

Functions

LPPAPI bool fileExists (const String &path)
 Return true if given file or directory exists. More...
 
LPPAPI uint64_t fileModified (const String &path)
 Return file last modified date and time. More...
 
LPPAPI bool touchFile (const String &path)
 Set file last modified date and time to now. More...
 
LPPAPI int64_t fileLength (const String &path)
 Return file length in bytes. More...
 
LPPAPI bool setFileLength (const String &path, int64_t length)
 Set new file length, truncating or expanding as required. More...
 
LPPAPI bool removeFile (const String &path)
 Delete file from file system. More...
 
LPPAPI bool copyFile (const String &source, const String &dest)
 Copy a file to/from file system. More...
 
LPPAPI bool createDirectory (const String &path)
 Create new directory under given location. More...
 
LPPAPI bool removeDirectory (const String &path)
 Delete directory from file system. More...
 
LPPAPI bool isDirectory (const String &path)
 Return true if given path points to a directory. More...
 
LPPAPI bool listDirectory (const String &path, bool filesOnly, HashSet< String > dirList)
 Return list of files (and/or directories) under given directory. More...
 
LPPAPI bool copyDirectory (const String &source, const String &dest)
 Copy a directory to/from file system. More...
 
LPPAPI String joinPath (const String &path, const String &file)
 Return complete path after joining given directory and file name. More...
 
LPPAPI String extractPath (const String &path)
 Extract parent path from given path. More...
 
LPPAPI String extractFile (const String &path)
 Extract file name from given path. More...
 

Function Documentation

LPPAPI bool Lucene::FileUtils::copyDirectory ( const String &  source,
const String &  dest 
)

Copy a directory to/from file system.

LPPAPI bool Lucene::FileUtils::copyFile ( const String &  source,
const String &  dest 
)

Copy a file to/from file system.

LPPAPI bool Lucene::FileUtils::createDirectory ( const String &  path)

Create new directory under given location.

LPPAPI String Lucene::FileUtils::extractFile ( const String &  path)

Extract file name from given path.

LPPAPI String Lucene::FileUtils::extractPath ( const String &  path)

Extract parent path from given path.

LPPAPI bool Lucene::FileUtils::fileExists ( const String &  path)

Return true if given file or directory exists.

LPPAPI int64_t Lucene::FileUtils::fileLength ( const String &  path)

Return file length in bytes.

LPPAPI uint64_t Lucene::FileUtils::fileModified ( const String &  path)

Return file last modified date and time.

LPPAPI bool Lucene::FileUtils::isDirectory ( const String &  path)

Return true if given path points to a directory.

LPPAPI String Lucene::FileUtils::joinPath ( const String &  path,
const String &  file 
)

Return complete path after joining given directory and file name.

LPPAPI bool Lucene::FileUtils::listDirectory ( const String &  path,
bool  filesOnly,
HashSet< String >  dirList 
)

Return list of files (and/or directories) under given directory.

Parameters
pathpath to list directory.
filesOnlyif true the exclude sub-directories.
dirListlist of files to return.
LPPAPI bool Lucene::FileUtils::removeDirectory ( const String &  path)

Delete directory from file system.

LPPAPI bool Lucene::FileUtils::removeFile ( const String &  path)

Delete file from file system.

LPPAPI bool Lucene::FileUtils::setFileLength ( const String &  path,
int64_t  length 
)

Set new file length, truncating or expanding as required.

LPPAPI bool Lucene::FileUtils::touchFile ( const String &  path)

Set file last modified date and time to now.


clucene.sourceforge.net