A class representing a temporarily available file in the filesystem. More...

Public Member Functions
	TemporaryFile (bool createFile=true, bool removeCreatedFiles=false)
	Creates a new file located in the temporary folder of the local filesystem. More...

	TemporaryFile (String path, bool createFile=true, bool removeCreatedFiles=false)
	Creates a new file in the location and with the name specified by. More...

	TemporaryFile (FilesystemPath path, bool createFile=true, bool removeCreatedFiles=false)
	Creates a new file in the location and with the name specified by. More...

	TemporaryFile (File file, bool createFile=true, bool removeCreatedFiles=false)
	Creates a new file in the location and with the name specified by. More...

	TemporaryFile (File file, bool removeCreatedFiles)

void	Create ()
	Creates the file without content. More...

void	Create (SystemIO.Stream contents)
	Creates the file with `content`. More...

SystemIO.Stream	CreateAndOpen ()
	Creates the file on the filesystem and opens it for writing. More...

SystemIO.Stream	Open (SystemIO.FileMode mode)
	Opens the file for reading or writing. More...

File	CopyTo (string dstPath, bool overwrite=false)
	Copies the file to a different path. More...

File	CopyTo (FilesystemPath dstPath, bool overwrite=false)
	Copies the file to a different path. More...

File	MoveTo (string dstPath)
	Moves the file to a different location. More...

File	MoveTo (FilesystemPath dstPath)
	Moves the file to a different location. More...

void	Delete ()
	Deletes the file on from the filesystem. More...

File	Replace (string dstPath, string backupPath)
	Replaces the file at `dstPath` with this file creating a backup in `backupPath`. More...

File	Replace (FilesystemPath dstPath, FilesystemPath backupPath)
	Replaces the file at `dstPath` with this file creating a backup in `backupPath`. More...

File	Replace (File dstFile, File backup)
	Replaces the file at `dstFile` with this file creating a backup in `backup`. More...

File	ReplaceWith (string srcPath, string backupPath)
	Replace this file's content with the content of the file at @psrcPath. More...

File	ReplaceWith (FilesystemPath srcPath, FilesystemPath backupPath)
	Replace this file's content with the content of the file at @psrcPath. More...

File	ReplaceWith (File srcFile, File backup)
	Replace this file's content with the content of `srcFile`. More...

void	Dispose ()
	Removes the temporary file if possible. More...

void	Create ()
	Creates the file without content. More...

void	Create (SystemIO.Stream contents)
	Creates the file with `content`. More...

SystemIO.Stream	CreateAndOpen ()
	Creates the file on the filesystem and opens it for writing. More...

SystemIO.Stream	Open (SystemIO.FileMode mode)
	Opens the file for reading or writing. More...

File	CopyTo (string dstPath, bool overwrite=false)
	Copies the file to a different path. More...

File	CopyTo (FilesystemPath dstPath, bool overwrite=false)
	Copies the file to a different path. More...

File	MoveTo (string dstPath)
	Moves the file to a different location. More...

File	MoveTo (FilesystemPath dstPath)
	Moves the file to a different location. More...

void	Delete ()
	Deletes the file on from the filesystem. More...

File	Replace (string dstPath, string backupPath)
	Replaces the file at `dstPath` with this file creating a backup in `backupPath`. More...

File	Replace (FilesystemPath dstPath, FilesystemPath backupPath)
	Replaces the file at `dstPath` with this file creating a backup in `backupPath`. More...

File	Replace (File dstFile, File backup)
	Replaces the file at `dstFile` with this file creating a backup in `backup`. More...

File	ReplaceWith (string srcPath, string backupPath)
	Replace this file's content with the content of the file at @psrcPath. More...

File	ReplaceWith (FilesystemPath srcPath, FilesystemPath backupPath)
	Replace this file's content with the content of the file at @psrcPath. More...

File	ReplaceWith (File srcFile, File backup)
	Replace this file's content with the content of `srcFile`. More...

Protected Member Functions
TemporaryFile	CreateTemporaryFile (File newFile)

virtual void	Dispose (bool disposing)

Protected Attributes
File	file

List< TemporaryFile >	createdFiles

Properties
String	Name `[get]`

String	Extension `[get]`
	The extension of the file. More...

FilesystemPath	Path `[get]`
	The path of the file. More...

Folder	Folder `[get]`
	The folder where the file is located. More...

DateTime	LastModificationTime `[get]`
	The time the file was last changed. More...

DateTime	CreationTime `[get]`
	The time the file was created. More...

bool	Exists `[get]`
	Checks if the file exists in the filesystem. More...

bool	IsWritable `[get]`
	Checks if the file is writable in the filesystem. More...

Properties inherited from Joutsen.IO.File
String	Name `[get]`

String	Extension `[get]`
	The extension of the file. More...

FilesystemPath	Path `[get]`
	The path of the file. More...

Folder	Folder `[get]`
	The folder where the file is located. More...

DateTime	LastModificationTime `[get]`
	The time the file was last changed. More...

DateTime	CreationTime `[get]`
	The time the file was created. More...

bool	Exists `[get]`
	Checks if the file exists in the filesystem. More...

bool	IsWritable `[get]`
	Checks if the file is writable in the filesystem. More...

Detailed Description

A class representing a temporarily available file in the filesystem.

Remarks: The file can actually be created and used as any other file and will only be removed if the object is disposed of. When using this class keep in mind that access rights can change and therefore the removal of the file might not be possible. Because the can be created anywhere on the filesystem and not only in the temp folder the caller should be aware that he/she first of all has to make sure the instance is dispose of and a possible remaining file does not cause problems.

Since: 0.4.0

Constructor & Destructor Documentation

◆ TemporaryFile() [1/5]

Joutsen.IO.TemporaryFile.TemporaryFile	(	bool	createFile = `true`,
		bool	removeCreatedFiles = `false`
	)

Creates a new file located in the temporary folder of the local filesystem.

Parameters

create	determines if the file should be created on the filesystem together with the new instance
removeCreatedFiles	determines if all files created by this instance should also be removed when this file is removed

◆ TemporaryFile() [2/5]

Joutsen.IO.TemporaryFile.TemporaryFile	(	String	path,
		bool	createFile = `true`,
		bool	removeCreatedFiles = `false`
	)

Creates a new file in the location and with the name specified by.

Parameters

path	in the local filesystem.
path	the full path to the file including its name
create	determines if the file should be created on the filesystem together with the new instance
removeCreatedFiles	determines if all files created by this instance should also be removed when this file is removed

Exceptions

ArgumentException if the specified file already exists

◆ TemporaryFile() [3/5]

Joutsen.IO.TemporaryFile.TemporaryFile	(	FilesystemPath	path,
		bool	createFile = `true`,
		bool	removeCreatedFiles = `false`
	)

Creates a new file in the location and with the name specified by.

Parameters

path	in the local filesystem.
path	the full path to the file including its name
create	determines if the file should be created on the filesystem together with the new instance
removeCreatedFiles	determines if all files created by this instance should also be removed when this file is removed

Exceptions

ArgumentException if the specified file already exists

◆ TemporaryFile() [4/5]

Joutsen.IO.TemporaryFile.TemporaryFile	(	File	file,
		bool	createFile = `true`,
		bool	removeCreatedFiles = `false`
	)

Creates a new file in the location and with the name specified by.

Parameters

path.
path	the full path to the file including its name
create	determines if the file should be created on the filesystem together with the new instance
removeCreatedFiles	determines if all files created by this instance should also be removed when this file is removed

Exceptions

ArgumentException if the specified file already exists

◆ TemporaryFile() [5/5]

Joutsen.IO.TemporaryFile.TemporaryFile	(	File	file,
		bool	removeCreatedFiles
	)

Member Function Documentation

◆ CopyTo() [1/2]

File Joutsen.IO.TemporaryFile.CopyTo	(	FilesystemPath	dstPath,
		bool	overwrite = `false`
	)

Copies the file to a different path.

Parameters

dstPath	the path to copy the file to
overwrite	determines if an existing file at `dstPath` should be overwritten

Returns: the file representing the copy

Exceptions

System.ArgumentNullException if dstPath is null

Implements Joutsen.IO.File.

◆ CopyTo() [2/2]

File Joutsen.IO.TemporaryFile.CopyTo	(	string	dstPath,
		bool	overwrite = `false`
	)

Copies the file to a different path.

Parameters

dstPath	the path to copy the file to
overwrite	determines if an existing file at `dstPath` should be overwritten

Returns: the file representing the copy

Implements Joutsen.IO.File.

◆ Create() [1/2]

void Joutsen.IO.TemporaryFile.Create ( )

Creates the file without content.

Implements Joutsen.IO.File.

◆ Create() [2/2]

void Joutsen.IO.TemporaryFile.Create ( SystemIO.Stream contents )

Creates the file with content.

Parameters

content the content that should be written to the new file

Implements Joutsen.IO.File.

◆ CreateAndOpen()

SystemIO.Stream Joutsen.IO.TemporaryFile.CreateAndOpen ( )

Creates the file on the filesystem and opens it for writing.

Returns: the open stream which can be used to write to the file

Remarks: The caller has to take care of closing the stream.

Implements Joutsen.IO.File.

◆ CreateTemporaryFile()

TemporaryFile Joutsen.IO.TemporaryFile.CreateTemporaryFile ( File newFile )

protected

◆ Delete()

void Joutsen.IO.TemporaryFile.Delete ( )

Deletes the file on from the filesystem.

Implements Joutsen.IO.File.

◆ Dispose() [1/2]

void Joutsen.IO.TemporaryFile.Dispose ( )

Removes the temporary file if possible.

◆ Dispose() [2/2]

virtual void Joutsen.IO.TemporaryFile.Dispose ( bool disposing )

protectedvirtual

◆ MoveTo() [1/2]

File Joutsen.IO.TemporaryFile.MoveTo ( FilesystemPath dstPath )

Moves the file to a different location.

Parameters

dstPath the path to move the file to

Returns: the file representing the moved file

Exceptions

System.ArgumentNullException if dstPath is null

Implements Joutsen.IO.File.

◆ MoveTo() [2/2]

File Joutsen.IO.TemporaryFile.MoveTo ( string dstPath )

Moves the file to a different location.

Parameters

dstPath the path to move the file to

Returns: the file representing the moved file

Implements Joutsen.IO.File.

◆ Open()

SystemIO.Stream Joutsen.IO.TemporaryFile.Open ( SystemIO.FileMode mode )

Opens the file for reading or writing.

Parameters

mode	determines if the file is opened for reading or writing

Returns: a stream representing the files content

Remarks: The stream is not closed automatically. The caller needs to take care of properly closing it.

Implements Joutsen.IO.File.

◆ Replace() [1/3]

File Joutsen.IO.TemporaryFile.Replace	(	File	dstFile,
		File	backup
	)

Replaces the file at dstFile with this file creating a backup in backup.

Parameters

dstFile	the file that should be replaced
backup	the file where the backup of `dstFile` should be stored

Returns: a file representing the backup of the replaced file or null if no backup is created

Exceptions

System.ArgumentNullException if dstFile is null

Remarks: If null is passed as backup, no backup is created.

Implements Joutsen.IO.File.

◆ Replace() [2/3]

File Joutsen.IO.TemporaryFile.Replace	(	FilesystemPath	dstPath,
		FilesystemPath	backupPath
	)

Replaces the file at dstPath with this file creating a backup in backupPath.

Parameters

dstpath	the path to the file that should be replaced
backupPath	the path to the location where the backup of `the` file at dstPath should be stored

Returns: a file representing the backup of the replaced file or null if no backup is created

Exceptions

System.ArgumentNullException if dstPath is null

Remarks: If null is passed as backupPath, no backup is created. The original file is deleted by this method.

Implements Joutsen.IO.File.

◆ Replace() [3/3]

File Joutsen.IO.TemporaryFile.Replace	(	string	dstPath,
		string	backupPath
	)

Replaces the file at dstPath with this file creating a backup in backupPath.

Parameters

dstpath	the path to the file that should be replaced
backupPath	the path to the location where the backup of `the` file at dstPath should be stored

Returns: a file representing the backup of the replaced file or null if no backup is created

Remarks: If null is passed as backupPath, no backup is created. The original file is deleted by this method.

Implements Joutsen.IO.File.

◆ ReplaceWith() [1/3]

File Joutsen.IO.TemporaryFile.ReplaceWith	(	File	srcFile,
		File	backup
	)

Replace this file's content with the content of srcFile.

Parameters

srcFile	the file that contains the content which should replace this file
backup	the file where the backup of this file should be stored

Returns: a file representing the backup of this file or null if no backup is created

Exceptions

System.ArgumentNullException if srcFile is null

Remarks: If null is passed as backup, no backup is created.

Implements Joutsen.IO.File.

◆ ReplaceWith() [2/3]

File Joutsen.IO.TemporaryFile.ReplaceWith	(	FilesystemPath	srcPath,
		FilesystemPath	backupPath
	)

Replace this file's content with the content of the file at @psrcPath.

Parameters

srcPath	the path to the file that contains the content which should replace this file
backup	the file where the backup of this file should be stored

Returns: a file representing the backup of this file or null if no backup is created

Exceptions

System.ArgumentNullException if srcFile is null

Remarks: If null is passed as backup, no backup is created.

Implements Joutsen.IO.File.

◆ ReplaceWith() [3/3]

File Joutsen.IO.TemporaryFile.ReplaceWith	(	string	srcPath,
		string	backupPath
	)

Replace this file's content with the content of the file at @psrcPath.

Parameters

srcPath	the path to the file that contains the content which should replace this file
backup	the file where the backup of this file should be stored

Returns: a file representing the backup of this file or null if no backup is created

Exceptions

System.ArgumentNullException if srcFile is null

Remarks: If null is passed as backup, no backup is created.

Implements Joutsen.IO.File.

Member Data Documentation

◆ createdFiles

List<TemporaryFile> Joutsen.IO.TemporaryFile.createdFiles

protected

◆ file

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TemporaryFile() [1/5]

◆ TemporaryFile() [2/5]

◆ TemporaryFile() [3/5]

◆ TemporaryFile() [4/5]

◆ TemporaryFile() [5/5]

Member Function Documentation

◆ CopyTo() [1/2]

◆ CopyTo() [2/2]

◆ Create() [1/2]

◆ Create() [2/2]

◆ CreateAndOpen()

◆ CreateTemporaryFile()

◆ Delete()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ MoveTo() [1/2]

◆ MoveTo() [2/2]

◆ Open()

◆ Replace() [1/3]

◆ Replace() [2/3]

◆ Replace() [3/3]

◆ ReplaceWith() [1/3]

◆ ReplaceWith() [2/3]

◆ ReplaceWith() [3/3]

Member Data Documentation

◆ createdFiles

◆ file

Property Documentation

◆ CreationTime

◆ Exists

◆ Extension

◆ Folder

◆ IsWritable

◆ LastModificationTime

◆ Name

◆ Path