Class Path

Interface to local filesystem path definition.

class Path( [path] )

more...

Summary

initInterface to local filesystem path definition.
extensionFile extension part.
fileFile part.
filenameFile name part.
locationLocation specificator.
pathComplete path.
unitUnit specificator.

Detailed description

Interface to local filesystem path definition.

This class offers an object oriented interface to access path elements given a complete path, or to build a path from its elements.

Init Block

Interface to local filesystem path definition.

init Path( [path] )

pathThe path that will be used as initial path.
Raises:
ParamErrorin case the inital path is malformed.

This class offers an object oriented interface to access path elements given a complete path, or to build a path from its elements.

Properties

extension

File extension part.

Raises:
ParamErrorif assigned to a value that makes the path invalid.

This element coresponds to the first last of the file element, if it is divided into a filename and an extension by a "." dot.

file

File part.

Raises:
ParamErrorif assigned to a value that makes the path invalid.

This is the part of the path that identifies an element in a directory. It includes everything after the last "/" path separator.

filename

File name part.

Raises:
ParamErrorif assigned to a value that makes the path invalid.

This element coresponds to the first part of the file element, if it is divided into a filename and an extension by a "." dot.

location

Location specificator.

Raises:
ParamErrorif assigned to a value that makes the path invalid.

This is the "path to file". It can start with a "/" or not; if it starts with a "/" it is considered absolute.

path

Complete path.

Raises:
ParamErrorif assigned to a value that makes the path invalid.

This is the complete path referred by this object.

unit

Unit specificator.

Raises:
ParamErrorif assigned to a value that makes the path invalid.

This is the unit specificator (disk name) used in some filesystems. It is separated by the rest of the path via a ":". According to RFC 3986 it always starts with a "/", which is automatically added if absent.


Made with faldoc 2.1.0