Directory base class More...

Inheritance diagram for Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >:

Public Member Functions
object	Clone ()
	Clones the directory object More...

int	CompareTo (IDirectory other)
	Compares this to another directory More...

int	CompareTo (object obj)
	Compares this object to another object More...

virtual IDirectory	CopyTo (IDirectory Directory, CopyOptions Options=CopyOptions.CopyAlways)
	Copies the directory to the specified parent directory More...

abstract void	Create ()
	Creates the directory More...

abstract void	Delete ()
	Deletes the directory More...

abstract IEnumerable< IDirectory >	EnumerateDirectories (string SearchPattern="*", SearchOption Options=SearchOption.TopDirectoryOnly)
	Enumerates directories under this directory More...

IEnumerable< IDirectory >	EnumerateDirectories (Predicate< IDirectory > Predicate, SearchOption Options=SearchOption.TopDirectoryOnly)
	Enumerates sub directories (defaults to top level sub directories) More...

abstract IEnumerable< IFile >	EnumerateFiles (string SearchPattern="*", SearchOption Options=SearchOption.TopDirectoryOnly)
	Enumerates files under this directory More...

IEnumerable< IFile >	EnumerateFiles (Predicate< IFile > Predicate, SearchOption Options=SearchOption.TopDirectoryOnly)
	Enumerates files within the directory (defaults to top level directory and not the sub directories) More...

override bool	Equals (object obj)
	Determines if the two directories are the same More...

bool	Equals (IDirectory other)
	Determines if the directories are equal More...

IEnumerator< IFile >	GetEnumerator ()
	Enumerates the files in the directory More...

override int	GetHashCode ()
	Returns the hash code for the directory More...

virtual IDirectory	MoveTo (IDirectory Directory)
	Moves this directory under another directory More...

abstract void	Rename (string Name)
	Renames the directory More...

override string	ToString ()
	Gets info for the directory More...

Static Public Member Functions
static bool	operator!= (DirectoryBase< InternalDirectoryType, DirectoryType > Directory1, IDirectory Directory2)
	Determines if two directories are not equal More...

static bool	operator< (DirectoryBase< InternalDirectoryType, DirectoryType > Directory1, IDirectory Directory2)
	Less than More...

static bool	operator<= (DirectoryBase< InternalDirectoryType, DirectoryType > Directory1, IDirectory Directory2)
	Less than or equal More...

static bool	operator== (DirectoryBase< InternalDirectoryType, DirectoryType > Directory1, IDirectory Directory2)
	Determines if two directories are equal More...

static bool	operator> (DirectoryBase< InternalDirectoryType, DirectoryType > Directory1, IDirectory Directory2)
	Greater than More...

static bool	operator>= (DirectoryBase< InternalDirectoryType, DirectoryType > Directory1, IDirectory Directory2)
	Greater than or equal More...

Protected Member Functions
	DirectoryBase ()
	Constructor More...

	DirectoryBase (InternalDirectoryType InternalDirectory, string UserName="", string Password="", string Domain="")
	Constructor More...

Properties
abstract DateTime	Accessed `[get]`
	Last time accessed (UTC time) More...

abstract DateTime	Created `[get]`
	Date created (UTC time) More...

abstract bool	Exists `[get]`
	Does it exist? More...

abstract string	FullName `[get]`
	Full path More...

abstract DateTime	Modified `[get]`
	Date modified (UTC time) More...

abstract string	Name `[get]`
	Name More...

abstract IDirectory	Parent `[get]`
	Parent directory More...

abstract IDirectory	Root `[get]`
	Root directory More...

abstract long	Size `[get]`
	Size of the directory More...

string	Domain `[get, set]`
	Domain More...

InternalDirectoryType	InternalDirectory `[get, set]`
	Internal directory More...

string	Password `[get, set]`
	Password More...

string	UserName `[get, set]`
	User name More...

Properties inherited from Utilities.IO.FileSystem.Interfaces.IDirectory
DateTime	Accessed `[get]`
	Last time it was accessed More...

DateTime	Created `[get]`
	When it was created More...

bool	Exists `[get]`
	Does the directory exist More...

string	FullName `[get]`
	Full path to the directory More...

DateTime	Modified `[get]`
	When it was last modified More...

string	Name `[get]`
	Name of the directory More...

IDirectory	Parent `[get]`
	Parent directory More...

IDirectory	Root `[get]`
	Root directory More...

long	Size `[get]`
	Size of the contents of the directory in bytes More...

Detailed Description

Directory base class

Template Parameters

InternalDirectoryType	Data type internally to hold true directory info
DirectoryType	Directory type

Type Constraints

DirectoryType	:	DirectoryBase
DirectoryType	:	InternalDirectoryType
DirectoryType	:	DirectoryType
DirectoryType	:	new()

Definition at line 38 of file DirectoryBase.cs.

Constructor & Destructor Documentation

Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.DirectoryBase ( )

protected

Constructor

Definition at line 44 of file DirectoryBase.cs.

Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.DirectoryBase	(	InternalDirectoryType	InternalDirectory,
		string	UserName = `""`,
		string	Password = `""`,
		string	Domain = `""`
	)

protected

Constructor

Parameters

InternalDirectory	Internal directory object
Domain	Domain of the user (optional)
Password	Password to be used to access the file (optional)
UserName	User name to be used to access the file (optional)

Definition at line 55 of file DirectoryBase.cs.

Member Function Documentation

object Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Clone ( )

Clones the directory object

Returns: The cloned object

Definition at line 210 of file DirectoryBase.cs.

int Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.CompareTo ( IDirectory other )

Compares this to another directory

Parameters

other Directory to compare to

Returns

Definition at line 225 of file DirectoryBase.cs.

int Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.CompareTo ( object obj )

Compares this object to another object

Parameters

obj	Object to compare it to

Returns

Definition at line 239 of file DirectoryBase.cs.

virtual IDirectory Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.CopyTo	(	IDirectory	Directory,
		CopyOptions	Options = `CopyOptions.CopyAlways`
	)

virtual

Copies the directory to the specified parent directory

Parameters

Directory	Directory to copy to
Options	Copy options

Returns: Returns the new directory

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 253 of file DirectoryBase.cs.

abstract void Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Create ( )

pure virtual

Creates the directory

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Implemented in Utilities.IO.FileSystem.Default.LocalDirectory.

abstract void Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Delete ( )

pure virtual

Deletes the directory

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Implemented in Utilities.IO.FileSystem.Default.LocalDirectory.

abstract IEnumerable<IDirectory> Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.EnumerateDirectories	(	string	SearchPattern = `"*"`,
		SearchOption	Options = `SearchOption.TopDirectoryOnly`
	)

pure virtual

Enumerates directories under this directory

Parameters

SearchPattern	Search pattern
Options	Search options

Returns: List of directories under this directory

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Implemented in Utilities.IO.FileSystem.Default.LocalDirectory.

IEnumerable<IDirectory> Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.EnumerateDirectories	(	Predicate< IDirectory >	Predicate,
		SearchOption	Options = `SearchOption.TopDirectoryOnly`
	)

Enumerates sub directories (defaults to top level sub directories)

Parameters

Predicate	Predicate used to filter directories
Options	Search options to use

Returns: The list of directories

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 312 of file DirectoryBase.cs.

abstract IEnumerable<IFile> Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.EnumerateFiles	(	string	SearchPattern = `"*"`,
		SearchOption	Options = `SearchOption.TopDirectoryOnly`
	)

pure virtual

Enumerates files under this directory

Parameters

SearchPattern	Search pattern
Options	Search options

Returns: List of files under this directory

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Implemented in Utilities.IO.FileSystem.Default.LocalDirectory.

IEnumerable<IFile> Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.EnumerateFiles	(	Predicate< IFile >	Predicate,
		SearchOption	Options = `SearchOption.TopDirectoryOnly`
	)

Enumerates files within the directory (defaults to top level directory and not the sub directories)

Parameters

Predicate	Predicate used to filter files
Options	Search options to use

Returns: The list of files

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 331 of file DirectoryBase.cs.

override bool Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Equals ( object obj )

Determines if the two directories are the same

Parameters

obj	Object to compare to

Returns: True if they're the same, false otherwise

Definition at line 341 of file DirectoryBase.cs.

bool Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Equals ( IDirectory other )

Determines if the directories are equal

Parameters

other Other directory

Returns: True if they are equal, false otherwise

Definition at line 352 of file DirectoryBase.cs.

IEnumerator<IFile> Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.GetEnumerator ( )

Enumerates the files in the directory

Returns: The files in the directory

Definition at line 363 of file DirectoryBase.cs.

override int Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.GetHashCode ( )

Returns the hash code for the directory

Returns: The hash code for the directory

Definition at line 373 of file DirectoryBase.cs.

virtual IDirectory Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.MoveTo ( IDirectory Directory )

virtual

Moves this directory under another directory

Parameters

Directory Directory to move to

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Definition at line 382 of file DirectoryBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.operator!=	(	DirectoryBase< InternalDirectoryType, DirectoryType >	Directory1,
		IDirectory	Directory2
	)

static

Determines if two directories are not equal

Parameters

Directory1	Directory 1
Directory2	Directory 2

Returns: True if they are not equal, false otherwise

Definition at line 134 of file DirectoryBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.operator<	(	DirectoryBase< InternalDirectoryType, DirectoryType >	Directory1,
		IDirectory	Directory2
	)

static

Less than

Parameters

Directory1	Directory 1
Directory2	Directory 2

Returns: The result

Definition at line 145 of file DirectoryBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.operator<=	(	DirectoryBase< InternalDirectoryType, DirectoryType >	Directory1,
		IDirectory	Directory2
	)

static

Less than or equal

Parameters

Directory1	Directory 1
Directory2	Directory 2

Returns: The result

Definition at line 158 of file DirectoryBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.operator==	(	DirectoryBase< InternalDirectoryType, DirectoryType >	Directory1,
		IDirectory	Directory2
	)

static

Determines if two directories are equal

Parameters

Directory1	Directory 1
Directory2	Directory 2

Returns: True if they are, false otherwise

Definition at line 171 of file DirectoryBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.operator>	(	DirectoryBase< InternalDirectoryType, DirectoryType >	Directory1,
		IDirectory	Directory2
	)

static

Greater than

Parameters

Directory1	Directory 1
Directory2	Directory 2

Returns: The result

Definition at line 186 of file DirectoryBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.operator>=	(	DirectoryBase< InternalDirectoryType, DirectoryType >	Directory1,
		IDirectory	Directory2
	)

static

Greater than or equal

Parameters

Directory1	Directory 1
Directory2	Directory 2

Returns: The result

Definition at line 199 of file DirectoryBase.cs.

abstract void Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Rename ( string Name )

pure virtual

Renames the directory

Parameters

Name	Name of the new directory

Implements Utilities.IO.FileSystem.Interfaces.IDirectory.

Implemented in Utilities.IO.FileSystem.Default.LocalDirectory.

override string Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.ToString ( )

Gets info for the directory

Returns: The full path to the directory

Definition at line 409 of file DirectoryBase.cs.

Property Documentation

abstract DateTime Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Accessed

get

Last time accessed (UTC time)

Definition at line 66 of file DirectoryBase.cs.

abstract DateTime Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Created

get

Date created (UTC time)

Definition at line 71 of file DirectoryBase.cs.

string Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Domain

getsetprotected

Domain

Definition at line 111 of file DirectoryBase.cs.

abstract bool Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Exists

get

Does it exist?

Definition at line 76 of file DirectoryBase.cs.

abstract string Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.FullName

get

Full path

Definition at line 81 of file DirectoryBase.cs.

InternalDirectoryType Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.InternalDirectory

getsetprotected

Internal directory

Definition at line 116 of file DirectoryBase.cs.

abstract DateTime Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Modified

get

Date modified (UTC time)

Definition at line 86 of file DirectoryBase.cs.

abstract string Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Name

get

Name

Definition at line 91 of file DirectoryBase.cs.

abstract IDirectory Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Parent

get

Parent directory

Definition at line 96 of file DirectoryBase.cs.

string Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Password

getsetprotected

Password

Definition at line 121 of file DirectoryBase.cs.

abstract IDirectory Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Root

get

Root directory

Definition at line 101 of file DirectoryBase.cs.

abstract long Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.Size

get

Size of the directory

Definition at line 106 of file DirectoryBase.cs.

string Utilities.IO.FileSystem.BaseClasses.DirectoryBase< InternalDirectoryType, DirectoryType >.UserName

getsetprotected

User name

Definition at line 126 of file DirectoryBase.cs.

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

Utilities/IO/FileSystem/BaseClasses/DirectoryBase.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation