Directory base class More...

Inheritance diagram for Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >:

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

int	CompareTo (IFile other)
	Compares this to another file More...

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

abstract IFile	CopyTo (IDirectory Directory, bool Overwrite)
	Copies the file to another directory More...

abstract string	Delete ()
	Deletes the file More...

override bool	Equals (object obj)
	Determines if the objects are equal More...

bool	Equals (IFile other)
	Determines if the files are equal More...

override int	GetHashCode ()
	Gets the hash code for the file More...

abstract void	MoveTo (IDirectory Directory)
	Moves the file to a new directory More...

abstract string	Read ()
	Reads the file in as a string More...

abstract byte[]	ReadBinary ()
	Reads a file as binary More...

abstract void	Rename (string NewName)
	Renames the file More...

override string	ToString ()
	Returns the name of the file More...

abstract string	Write (string Content, System.IO.FileMode Mode=FileMode.Create, Encoding Encoding=null)
	Writes content to the file More...

abstract byte[]	Write (byte[] Content, System.IO.FileMode Mode=FileMode.Create)
	Writes content to the file More...

Public Member Functions inherited from Utilities.IO.FileSystem.Interfaces.IFile
string	Write (string Content, FileMode Mode=FileMode.Create, Encoding Encoding=null)
	Writes content to the file More...

byte[]	Write (byte[] Content, FileMode Mode=FileMode.Create)
	Writes content to the file More...

Static Public Member Functions
static implicit	operator byte[] (FileBase< InternalFileType, FileType > File)
	Reads the file and converts it to a byte array More...

static implicit	operator string (FileBase< InternalFileType, FileType > File)
	Reads the file and converts it to a string More...

static bool	operator!= (FileBase< InternalFileType, FileType > File1, IFile File2)
	Determines if two directories are not equal More...

static bool	operator< (FileBase< InternalFileType, FileType > File1, IFile File2)
	Less than More...

static bool	operator<= (FileBase< InternalFileType, FileType > File1, IFile File2)
	Less than or equal More...

static bool	operator== (FileBase< InternalFileType, FileType > File1, IFile File2)
	Determines if two directories are equal More...

static bool	operator> (FileBase< InternalFileType, FileType > File1, IFile File2)
	Greater than More...

static bool	operator>= (FileBase< InternalFileType, FileType > File1, IFile File2)
	Greater than or equal More...

Protected Member Functions
	FileBase ()
	Constructor More...

	FileBase (InternalFileType InternalFile)
	Constructor More...

	FileBase (InternalFileType InternalFile, string UserName, string Password, string Domain)
	Constructor More...

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

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

abstract IDirectory	Directory `[get]`
	Directory the file is within More...

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

abstract string	Extension `[get]`
	File extension More...

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

abstract long	Length `[get]`
	Size of the file More...

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

abstract string	Name `[get]`
	Name of the file More...

string	Domain `[get, set]`
	Domain of the user More...

InternalFileType	InternalFile `[get, set]`
	Internal directory More...

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

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

Properties inherited from Utilities.IO.FileSystem.Interfaces.IFile
DateTime	Accessed `[get]`
	Last time the file was accessed More...

DateTime	Created `[get]`
	When the file was created More...

IDirectory	Directory `[get]`
	Directory the file is in More...

bool	Exists `[get]`
	Does the file exist currently More...

string	Extension `[get]`
	File extension More...

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

long	Length `[get]`
	Size of the file in bytes More...

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

string	Name `[get]`
	File name More...

Detailed Description

Directory base class

Template Parameters

FileType	File type
InternalFileType	Internal file type

Type Constraints

FileType	:	FileBase
FileType	:	InternalFileType
FileType	:	FileType
FileType	:	new()

Definition at line 34 of file FileBase.cs.

Constructor & Destructor Documentation

Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.FileBase ( )

protected

Constructor

Definition at line 40 of file FileBase.cs.

Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.FileBase ( InternalFileType InternalFile )

protected

Constructor

Parameters

InternalFile Internal file

Definition at line 48 of file FileBase.cs.

Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.FileBase	(	InternalFileType	InternalFile,
		string	UserName,
		string	Password,
		string	Domain
	)

protected

Constructor

Parameters

InternalFile	Internal file
UserName	User name
Password	Password
Domain	User's domain

Definition at line 61 of file FileBase.cs.

Member Function Documentation

object Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Clone ( )

Clones the file object

Returns: The cloned object

Definition at line 240 of file FileBase.cs.

int Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.CompareTo ( IFile other )

Compares this to another file

Parameters

other File to compare to

Returns

Definition at line 255 of file FileBase.cs.

int Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.CompareTo ( object obj )

Compares this object to another object

Parameters

obj	Object to compare it to

Returns

Definition at line 267 of file FileBase.cs.

abstract IFile Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.CopyTo	(	IDirectory	Directory,
		bool	Overwrite
	)

pure virtual

Copies the file to another directory

Parameters

Directory	Directory to copy the file to
Overwrite	Should the file overwrite another file if found

Returns: The newly created file

Implements Utilities.IO.FileSystem.Interfaces.IFile.

abstract string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Delete ( )

pure virtual

Deletes the file

Returns: Any response for deleting the resource (usually FTP, HTTP, etc)

Implements Utilities.IO.FileSystem.Interfaces.IFile.

Implemented in Utilities.IO.FileSystem.Default.FtpFile, Utilities.IO.FileSystem.Default.WebFile, and Utilities.IO.FileSystem.Default.LocalFile.

override bool Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Equals ( object obj )

Determines if the objects are equal

Parameters

obj	Object to compare to

Returns: True if they are equal, false otherwise

Definition at line 294 of file FileBase.cs.

bool Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Equals ( IFile other )

Determines if the files are equal

Parameters

other Other file

Returns: True if they are equal, false otherwise

Definition at line 305 of file FileBase.cs.

override int Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.GetHashCode ( )

Gets the hash code for the file

Returns: The hash code

Definition at line 316 of file FileBase.cs.

abstract void Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.MoveTo ( IDirectory Directory )

pure virtual

Moves the file to a new directory

Parameters

Directory Directory to move to

Implements Utilities.IO.FileSystem.Interfaces.IFile.

static implicit Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.operator byte[] ( FileBase< InternalFileType, FileType > File )

static

Reads the file and converts it to a byte array

Parameters

File	File to read

Returns: The file as a byte array

Definition at line 139 of file FileBase.cs.

static implicit Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.operator string ( FileBase< InternalFileType, FileType > File )

static

Reads the file and converts it to a string

Parameters

File	File to read

Returns: The file as a string

Definition at line 151 of file FileBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.operator!=	(	FileBase< InternalFileType, FileType >	File1,
		IFile	File2
	)

static

Determines if two directories are not equal

Parameters

File1	File 1
File2	File 2

Returns: True if they are not equal, false otherwise

Definition at line 164 of file FileBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.operator<	(	FileBase< InternalFileType, FileType >	File1,
		IFile	File2
	)

static

Less than

Parameters

File1	File 1
File2	File 2

Returns: The result

Definition at line 175 of file FileBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.operator<=	(	FileBase< InternalFileType, FileType >	File1,
		IFile	File2
	)

static

Less than or equal

Parameters

File1	File 1
File2	File 2

Returns: The result

Definition at line 188 of file FileBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.operator==	(	FileBase< InternalFileType, FileType >	File1,
		IFile	File2
	)

static

Determines if two directories are equal

Parameters

File1	File 1
File2	File 2

Returns: True if they are, false otherwise

Definition at line 201 of file FileBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.operator>	(	FileBase< InternalFileType, FileType >	File1,
		IFile	File2
	)

static

Greater than

Parameters

File1	File 1
File2	File 2

Returns: The result

Definition at line 216 of file FileBase.cs.

static bool Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.operator>=	(	FileBase< InternalFileType, FileType >	File1,
		IFile	File2
	)

static

Greater than or equal

Parameters

File1	File 1
File2	File 2

Returns: The result

Definition at line 229 of file FileBase.cs.

abstract string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Read ( )

pure virtual

Reads the file in as a string

Returns: The file contents as a string

Implements Utilities.IO.FileSystem.Interfaces.IFile.

Implemented in Utilities.IO.FileSystem.Default.WebFile, Utilities.IO.FileSystem.Default.FtpFile, and Utilities.IO.FileSystem.Default.LocalFile.

abstract byte [] Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.ReadBinary ( )

pure virtual

Reads a file as binary

Returns: The file contents as a byte array

Implements Utilities.IO.FileSystem.Interfaces.IFile.

Implemented in Utilities.IO.FileSystem.Default.WebFile, Utilities.IO.FileSystem.Default.FtpFile, and Utilities.IO.FileSystem.Default.LocalFile.

abstract void Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Rename ( string NewName )

pure virtual

Renames the file

Parameters

NewName New name for the file

Implements Utilities.IO.FileSystem.Interfaces.IFile.

Implemented in Utilities.IO.FileSystem.Default.LocalFile, Utilities.IO.FileSystem.Default.WebFile, and Utilities.IO.FileSystem.Default.FtpFile.

override string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.ToString ( )

Returns the name of the file

Returns: The name of the file

Definition at line 349 of file FileBase.cs.

abstract string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Write	(	string	Content,
		System.IO.FileMode	Mode = `FileMode.Create`,
		Encoding	Encoding = `null`
	)

pure virtual

Writes content to the file

Parameters

Content	Content to write
Mode	Mode to open the file as
Encoding	Encoding to use for the content

Returns: The result of the write or original content

Implemented in Utilities.IO.FileSystem.Default.LocalFile, Utilities.IO.FileSystem.Default.WebFile, and Utilities.IO.FileSystem.Default.FtpFile.

abstract byte [] Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Write	(	byte[]	Content,
		System.IO.FileMode	Mode = `FileMode.Create`
	)

pure virtual

Writes content to the file

Parameters

Content	Content to write
Mode	Mode to open the file as

Returns: The result of the write or original content

Implemented in Utilities.IO.FileSystem.Default.WebFile, Utilities.IO.FileSystem.Default.LocalFile, and Utilities.IO.FileSystem.Default.FtpFile.

Property Documentation

abstract DateTime Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Accessed

get

Last time accessed (UTC time)

Definition at line 72 of file FileBase.cs.

abstract DateTime Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Created

get

Time created (UTC time)

Definition at line 77 of file FileBase.cs.

abstract IDirectory Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Directory

get

Directory the file is within

Definition at line 82 of file FileBase.cs.

string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Domain

getsetprotected

Domain of the user

Definition at line 117 of file FileBase.cs.

abstract bool Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Exists

get

Does the file exist?

Definition at line 87 of file FileBase.cs.

abstract string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Extension

get

File extension

Definition at line 92 of file FileBase.cs.

abstract string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.FullName

get

Full path

Definition at line 97 of file FileBase.cs.

InternalFileType Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.InternalFile

getsetprotected

Internal directory

Definition at line 122 of file FileBase.cs.

abstract long Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Length

get

Size of the file

Definition at line 102 of file FileBase.cs.

abstract DateTime Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Modified

get

Time modified (UTC time)

Definition at line 107 of file FileBase.cs.

abstract string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Name

get

Name of the file

Definition at line 112 of file FileBase.cs.

string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.Password

getsetprotected

Password

Definition at line 127 of file FileBase.cs.

string Utilities.IO.FileSystem.BaseClasses.FileBase< InternalFileType, FileType >.UserName

getsetprotected

User name used

Definition at line 132 of file FileBase.cs.

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

Utilities/IO/FileSystem/BaseClasses/FileBase.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation