Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

MutableFilePath Class Reference

Inheritance diagram for MutableFilePath:

FilePath List of all members.

Public Member Functions

 this ()
 this (FilePath other)
MutableFilePath setExt (char[] ext)
MutableFilePath setName (char[] name)
MutableFilePath setPath (char[] path)
MutableFilePath setRoot (char[] root)
MutableFilePath setSuffix (char[] suffix)

Private Member Functions

 this (Uri uri)
 this (char[] filepath)
bool isAbsolute ()
char[] getRoot ()
char[] getPath ()
char[] getName ()
char[] getExtension ()
char[] getSuffix ()
char[] toString ()
MutableUri toUri ()
void write (IWriter writer)
char * toStringZ ()
char[] splice (FilePath base)
IBuffer splice (FilePath base, IBuffer buf)
FilePath toParent ()
bool isChild ()
FilePath toSibling (char[] name)
FilePath toSibling (char[] name, char[] ext)
FilePath toSibling (char[] name, char[] ext, char[] suffix)

Detailed Description

Mutable version of FilePath, which allows one to change individual attributes. A change to any attribute will cause method toString() to rebuild the output.

Definition at line 545 of file FilePath.d.


Member Function Documentation

this  )  [inline]
 

Create an empty MutableFilePath

Reimplemented from FilePath.

Definition at line 553 of file FilePath.d.

this FilePath  other  )  [inline]
 

Create a MutableFilePath through reference to another.

Reimplemented from FilePath.

Definition at line 563 of file FilePath.d.

MutableFilePath setExt char[]  ext  )  [inline]
 

Set the extension of this FilePath.

Definition at line 574 of file FilePath.d.

MutableFilePath setName char[]  name  )  [inline]
 

Set the name of this FilePath.

Definition at line 587 of file FilePath.d.

MutableFilePath setPath char[]  path  )  [inline]
 

Set the path of this FilePath.

Definition at line 600 of file FilePath.d.

MutableFilePath setRoot char[]  root  )  [inline]
 

Set the root of this FilePath (such as "c:")

Definition at line 613 of file FilePath.d.

MutableFilePath setSuffix char[]  suffix  )  [inline]
 

Set the suffix of this FilePath.

Definition at line 626 of file FilePath.d.

this Uri  uri  )  [inline, inherited]
 

Create a FilePath from a Uri. Note that the Uri authority is used to house an optional root (device, drive-letter ...)

Definition at line 110 of file FilePath.d.

this char[]  filepath  )  [inline, inherited]
 

Create a FilePath from the given string. Note the path is not duplicated here, so you are expected to provide an immutable copy for the lifetime of this object.

If you're not certain, duplicate the path first.

Definition at line 130 of file FilePath.d.

bool isAbsolute  )  [inline, inherited]
 

Returns true if this FilePath is *not* relative to the current working directory.

Definition at line 215 of file FilePath.d.

References FilePath::root.

char [] getRoot  )  [inline, inherited]
 

Return the root of this path. Roots are constructs such as "c:".

Definition at line 229 of file FilePath.d.

References FilePath::root.

char [] getPath  )  [inline, inherited]
 

Return the file path. Paths start with a '/' but do not end with one. The root path is empty. Directory paths are split such that the directory name is placed into the 'name' member.

Definition at line 243 of file FilePath.d.

char [] getName  )  [inline, inherited]
 

Return the name of this file, or directory.

Definition at line 254 of file FilePath.d.

Referenced by testScanFiles().

char [] getExtension  )  [inline, inherited]
 

Return the file-extension, sans seperator

Definition at line 265 of file FilePath.d.

Referenced by ServletResponse::copyFile(), and testScanFiles().

char [] getSuffix  )  [inline, inherited]
 

Suffix is like extension, except it can include multiple '.' sequences. For example, "wumpus1.foo.bar" has suffix "foo.bar" and extension "bar".

Definition at line 278 of file FilePath.d.

References FilePath::suffix.

char [] toString  )  [inline, inherited]
 

Convert this FilePath to a char[]. This is expected to execute optimally in most cases.

Definition at line 290 of file FilePath.d.

References IBuffer::append(), Buffer::append(), Buffer, FilePath::ext, FilePath::fp, FilePath::MaxFilePathSize, FilePath::root, version, and FilePath::write().

Referenced by FileBucket::Record::eof(), FileProxy::VersionWin32::toList(), FileProxy::toString(), and FilePath::toStringZ().

MutableUri toUri  )  [inline, inherited]
 

Convert this FilePath to a Uri. Note that a root (such as a drive-letter, or device) is placed into the Uri authority

Definition at line 325 of file FilePath.d.

References FilePath::ext, FilePath::root, MutableUri::setHost(), MutableUri::setPath(), MutableUri::setScheme(), and version.

Referenced by testFilePath().

void write IWriter  writer  )  [inline, inherited]
 

Write this FilePath to the given IWriter. This makes the FilePath compatible with all Writers

Reimplemented from IWritable.

Definition at line 352 of file FilePath.d.

References FilePath::ext, IWriter::put(), and FilePath::root.

Referenced by FilePath::toString().

char* toStringZ  )  [inline, inherited]
 

Return a zero terminated version of this file path. Note that the compiler places a zero at the end of each static string, as does the allocator for char[] requests.

In typical usage, this will not need to duplicate the path

Definition at line 377 of file FilePath.d.

References FilePath::toString().

Referenced by FileConduit::Versionlinux::_open(), FileConduit::VersionWin32::_open(), FileProxy::Versionlinux::createDirectory(), FileProxy::VersionWin32::createDirectory(), FileProxy::Versionlinux::createFile(), FileProxy::VersionWin32::createFile(), FileProxy::Versionlinux::getInfo(), FileProxy::VersionWin32::getInfo(), FileProxy::Versionlinux::remove(), FileProxy::VersionWin32::remove(), FileSystem::Versionlinux::setDirectory(), FileSystem::VersionWin32::setDirectory(), and FileProxy::Versionlinux::toList().

char [] splice FilePath  base  )  [inline, inherited]
 

Splice this FilePath onto the end of the provided base path. Output is return as a char[].

Definition at line 401 of file FilePath.d.

References Buffer, and FilePath::MaxFilePathSize.

IBuffer splice FilePath  base,
IBuffer  buf
[inline, inherited]
 

Splice this FilePath onto the end of the provided base path. Output is placed into the provided IBuffer.

Definition at line 413 of file FilePath.d.

References IBuffer::append(), FilePath::ext, FilePath::name, FilePath::path, and FilePath::root.

FilePath toParent  )  [inline, inherited]
 

Returns a FilePath representing the parent of this one. An exception is thrown if there is not parent (at the root).

Definition at line 462 of file FilePath.d.

References FilePath, FilePath::fp, FilePath::locateParent(), and FilePath::path.

bool isChild  )  [inline, inherited]
 

Returns true if this FilePath has a parent.

Definition at line 487 of file FilePath.d.

FilePath toSibling char[]  name  )  [inline, inherited]
 

Return a cloned FilePath with a different name.

Definition at line 498 of file FilePath.d.

Referenced by FilePath::toSibling().

FilePath toSibling char[]  name,
char[]  ext
[inline, inherited]
 

Return a cloned FilePath with a different name and extension. Note that the suffix is destroyed.

Definition at line 510 of file FilePath.d.

References FilePath::toSibling().

FilePath toSibling char[]  name,
char[]  ext,
char[]  suffix
[inline, inherited]
 

Return a cloned FilePath with a different name, extension, and suffix.

Definition at line 522 of file FilePath.d.

References FilePath, and FilePath::fp.


The documentation for this class was generated from the following file:
Generated on Sun Oct 24 22:31:28 2004 for Mango by doxygen 1.3.6