Craig's Utility Library  4.0 Beta
Utilities.IO.FileSystem.BaseClasses.FileSystemBase Class Referenceabstract

File system base class More...

Inheritance diagram for Utilities.IO.FileSystem.BaseClasses.FileSystemBase:
Utilities.DataTypes.Patterns.BaseClasses.SafeDisposableBaseClass Utilities.IO.FileSystem.Interfaces.IFileSystem Utilities.IO.FileSystem.BaseClasses.LocalFileSystemBase Utilities.IO.FileSystem.Default.FtpFileSystem Utilities.IO.FileSystem.Default.HttpFileSystem Utilities.IO.FileSystem.Default.ResourceFileSystem Utilities.IO.FileSystem.Default.AbsoluteLocalFileSystem Utilities.IO.FileSystem.Default.NetworkFileSystem Utilities.IO.FileSystem.Default.RelativeLocalFileSystem

Public Member Functions

bool CanHandle (string Path)
 Returns true if it can handle the path, false otherwise More...
 
abstract IDirectory Directory (string Path, string UserName="", string Password="", string Domain="")
 Gets the directory representation for the directory More...
 
abstract IFile File (string Path, string UserName="", string Password="", string Domain="")
 Gets the class representation for the file More...
 
- Public Member Functions inherited from Utilities.DataTypes.Patterns.BaseClasses.SafeDisposableBaseClass
void Dispose ()
 Dispose function More...
 

Protected Member Functions

 FileSystemBase ()
 Constructor More...
 
abstract string AbsolutePath (string Path)
 Gets the absolute path of the variable passed in More...
 
- Protected Member Functions inherited from Utilities.DataTypes.Patterns.BaseClasses.SafeDisposableBaseClass
 SafeDisposableBaseClass ()
 Construct More...
 
abstract void Dispose (bool Managed)
 Function to override in order to dispose objects More...
 

Properties

abstract string Name [get]
 Name of the file system More...
 
Regex HandleRegex [get]
 Regex used to determine if the file system can handle the path More...
 
abstract string HandleRegexString [get]
 Regex string used to determine if the file system can handle the path More...
 
- Properties inherited from Utilities.IO.FileSystem.Interfaces.IFileSystem
string Name [get]
 Name of the file system More...
 

Detailed Description

File system base class

Definition at line 31 of file FileSystemBase.cs.

Constructor & Destructor Documentation

Utilities.IO.FileSystem.BaseClasses.FileSystemBase.FileSystemBase ( )
protected

Constructor

Definition at line 36 of file FileSystemBase.cs.

Member Function Documentation

abstract string Utilities.IO.FileSystem.BaseClasses.FileSystemBase.AbsolutePath ( string  Path)
protectedpure virtual

Gets the absolute path of the variable passed in

Parameters
PathPath to convert to absolute
Returns
The absolute path of the path passed in

Implemented in Utilities.IO.FileSystem.Default.RelativeLocalFileSystem, Utilities.IO.FileSystem.Default.AbsoluteLocalFileSystem, and Utilities.IO.FileSystem.Default.NetworkFileSystem.

bool Utilities.IO.FileSystem.BaseClasses.FileSystemBase.CanHandle ( string  Path)

Returns true if it can handle the path, false otherwise

Parameters
PathThe path to check against
Returns
True if it can handle the path, false otherwise

Implements Utilities.IO.FileSystem.Interfaces.IFileSystem.

Definition at line 61 of file FileSystemBase.cs.

abstract IDirectory Utilities.IO.FileSystem.BaseClasses.FileSystemBase.Directory ( string  Path,
string  UserName = "",
string  Password = "",
string  Domain = "" 
)
pure virtual

Gets the directory representation for the directory

Parameters
PathPath to the directory
DomainDomain of the user (optional)
PasswordPassword to be used to access the directory (optional)
UserNameUser name to be used to access the directory (optional)
Returns
The directory object

Implements Utilities.IO.FileSystem.Interfaces.IFileSystem.

Implemented in Utilities.IO.FileSystem.BaseClasses.LocalFileSystemBase.

abstract IFile Utilities.IO.FileSystem.BaseClasses.FileSystemBase.File ( string  Path,
string  UserName = "",
string  Password = "",
string  Domain = "" 
)
pure virtual

Gets the class representation for the file

Parameters
PathPath to the file
DomainDomain of the user (optional)
PasswordPassword to be used to access the file (optional)
UserNameUser name to be used to access the file (optional)
Returns
The file object

Implements Utilities.IO.FileSystem.Interfaces.IFileSystem.

Implemented in Utilities.IO.FileSystem.BaseClasses.LocalFileSystemBase.

Property Documentation

Regex Utilities.IO.FileSystem.BaseClasses.FileSystemBase.HandleRegex
getprotected

Regex used to determine if the file system can handle the path

Definition at line 49 of file FileSystemBase.cs.

abstract string Utilities.IO.FileSystem.BaseClasses.FileSystemBase.HandleRegexString
getprotected

Regex string used to determine if the file system can handle the path

Definition at line 54 of file FileSystemBase.cs.

abstract string Utilities.IO.FileSystem.BaseClasses.FileSystemBase.Name
get

Name of the file system

Definition at line 44 of file FileSystemBase.cs.


The documentation for this class was generated from the following file: