SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND


Platform
Class Path
Implemented in:
Platform.Path.h

class Path

Represents a path to a filesystem object such as a file or directory.

Inner Compounds, Typedefs, and Enumscollapse
enum Components
          Lists the components of a path for use with toString method.

Field Summarycollapse
static const Char PathSeparator
          Denotes a separator of path names in a sequence of paths.
static const Char Separator
          Denotes a separator of directory names in a path.

Constructor Summarycollapse
Path()
          Creates an empty Path object.
Path(const String& path)
          Creates a new path object from the specified string.

Method Summarycollapse
StringArray& directories()
          Returns the list of directories of the path.
const StringArray& directories() const
          Returns the list of directories of the path.
Bool equals(const Path& path) const
          DOCTODO.
Void exchangeWith(Path& path)
          DOCTODO.
String& extension()
          Returns the file name extension component of the path.
const String& extension() const
          Returns the file name extension component of the path.
String extensionNoDot() const
          Returns the file name extension component of the path.
String& filename()
          Returns the file name component of the path.
const String& filename() const
          Returns the file name component of the path.
Bool hasDirectories() const
          DOCTODO.
Bool hasExtension() const
          DOCTODO.
Bool hasFilename() const
          DOCTODO.
Bool hasRoot() const
          DOCTODO.
Bool isEmpty() const
          DOCTODO.
Bool isValid(Int components = Components_All) const
          Tests whether the path is valid.
Void normalize()
          DOCTODO.
Path operator+(const Path& path) const
          DOCTODO.
Path operator+(const String& path) const
          DOCTODO.
Path& operator+=(const Path& path)
          DOCTODO.
Path& operator+=(const String& path)
          DOCTODO.
String& root()
          Returns the root component of the path.
const String& root() const
          Returns the root component of the path.
String toString(Int components = Components_All) const
          DOCTODO.

 

Field Detail

PathSeparator

static const Char PathSeparator

Denotes a separator of path names in a sequence of paths. On UNIX systems this character is ':'; on Windows systems it is ';'.


Separator

static const Char Separator

Denotes a separator of directory names in a path. On UNIX and Windows systems this character is '/'.

 

Constructor Detail

Path[inline]

Path()

Creates an empty Path object.


Path[nothrow, inline]

Path(const String& path)

Creates a new path object from the specified string.

Parameters:
path - a string denoting a path

 

Method Detail

directories[nothrow, inline]

StringArray& directories()

Returns the list of directories of the path.

Returns:
Returns the list of directories of the path

directories[nothrow, inline]

const StringArray& directories() const

Returns the list of directories of the path.

Returns:
Returns the list of directories of the path

equals[nothrow, inline]

Bool equals(const Path& path) const

DOCTODO.

Parameters:
path - DOCTODO
Returns:
DOCTODO

exchangeWith[nothrow, inline]

Void exchangeWith(Path& path)

DOCTODO.

Parameters:
path - DOCTODO
Returns:
DOCTODO

extension[nothrow, inline]

String& extension()

Returns the file name extension component of the path. The extension includes a dot character.

Returns:
the file name extension component of the path, including the dot character

extension[nothrow, inline]

const String& extension() const

Returns the file name extension component of the path. The extension includes a dot character.

Returns:
the file name extension component of the path, including the dot character

extensionNoDot[nothrow, inline]

String extensionNoDot() const

Returns the file name extension component of the path.

Returns:
the file name extension component of the path

filename[nothrow, inline]

String& filename()

Returns the file name component of the path.

Returns:
the file name component of the path

filename[nothrow, inline]

const String& filename() const

Returns the file name component of the path.

Returns:
the file name component of the path

hasDirectories[nothrow, inline]

Bool hasDirectories() const

DOCTODO.

Returns:
True if the path has a list of directories, False otherwise

hasExtension[nothrow, inline]

Bool hasExtension() const

DOCTODO.

Returns:
True if the path has a file name extension component, False otherwise

hasFilename[nothrow, inline]

Bool hasFilename() const

DOCTODO.

Returns:
True if the path has a file name component, False otherwise

hasRoot[nothrow, inline]

Bool hasRoot() const

DOCTODO.

Returns:
True if the path has a root component, False otherwise

isEmpty[nothrow, inline]

Bool isEmpty() const

DOCTODO.

Returns:
DOCTODO

isValid[nothrow]

Bool isValid(Int components = Components_All) const

Tests whether the path is valid.

Parameters:
components - DOCTODO
Returns:
True if the path is a valid path, False otherwise

normalize[nothrow]

Void normalize()

DOCTODO.


operator+[inline]

Path operator+(const Path& path) const

DOCTODO.

Parameters:
path - DOCTODO
Returns:
DOCTODO

operator+[inline]

Path operator+(const String& path) const

DOCTODO.

Parameters:
path - DOCTODO
Returns:
DOCTODO

operator+=[inline]

Path& operator+=(const Path& path)

DOCTODO.

Parameters:
path - DOCTODO
Returns:
DOCTODO

operator+=[inline]

Path& operator+=(const String& path)

DOCTODO.

Parameters:
path - DOCTODO
Returns:
DOCTODO

root[nothrow, inline]

String& root()

Returns the root component of the path.

Returns:
the root component of the path

root[nothrow, inline]

const String& root() const

Returns the root component of the path.

Returns:
the root component of the path

toString[nothrow]

String toString(Int components = Components_All) const

DOCTODO.

Parameters:
components - DOCTODO
Returns:
DOCTODO


SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND