Org.Apache.REEF.IO.FileSystem.IFileSystem Interface Reference

A file system abstraction. More...

Inherited by Org.Apache.REEF.IO.FileSystem.AzureBlob.AzureBlockBlobFileSystem, Org.Apache.REEF.IO.FileSystem.Hadoop.HadoopFileSystem, and Org.Apache.REEF.IO.FileSystem.Local.LocalFileSystem.

Public Member Functions
Stream	Open (Uri fileUri)
	Opens the given URI for reading More...
Stream	Create (Uri fileUri)
	Creates a new file under the given URI. More...
void	Delete (Uri fileUri)
	Deletes the file under the given URI. More...
bool	Exists (Uri fileUri)
	Determines whether a file exists under the given URI. More...
void	Copy (Uri sourceUri, Uri destinationUri)
	Copies the file referenced by sourceUri to destinationUri. More...
void	CopyToLocal (Uri remoteFileUri, string localName)
	Copies the remote file to a local file. More...
void	CopyFromLocal (string localFileName, Uri remoteFileUri)
	Copies the specified file to the remote location. More...
void	CreateDirectory (Uri directoryUri)
	Creates a new directory. More...
void	DeleteDirectory (Uri directoryUri)
	Deletes a directory. More...
IEnumerable< Uri >	GetChildren (Uri directoryUri)
	Get the children on the given URI, if that refers to a directory. More...
Uri	CreateUriForPath (string path)
	Create Uri from a given file path. More...
FileStatus	GetFileStatus (Uri remoteFileUri)
	Gets the FileStatus for remote file. More...

Detailed Description

A file system abstraction.

Member Function Documentation

Copy()

void Org.Apache.REEF.IO.FileSystem.IFileSystem.Copy	(	Uri	sourceUri,
		Uri	destinationUri
	)

Copies the file referenced by sourceUri to destinationUri.

Parameters

sourceUri
destinationUri

Exceptions

IOException

CopyFromLocal()

void Org.Apache.REEF.IO.FileSystem.IFileSystem.CopyFromLocal	(	string	localFileName,
		Uri	remoteFileUri
	)

Copies the specified file to the remote location.

Parameters

localFileName
remoteFileUri

Exceptions

IOException

CopyToLocal()

void Org.Apache.REEF.IO.FileSystem.IFileSystem.CopyToLocal	(	Uri	remoteFileUri,
		string	localName
	)

Copies the remote file to a local file.

Parameters

remoteFileUri
localName

Exceptions

IOException

Create()

Stream Org.Apache.REEF.IO.FileSystem.IFileSystem.Create

(

Uri

fileUri

)

Creates a new file under the given URI.

Parameters

fileUri

Returns

Exceptions

IOException

If the URI couldn't be created.

CreateDirectory()

void Org.Apache.REEF.IO.FileSystem.IFileSystem.CreateDirectory

(

Uri

directoryUri

)

Creates a new directory.

Parameters

directoryUri

Exceptions

IOException

CreateUriForPath()

Uri Org.Apache.REEF.IO.FileSystem.IFileSystem.CreateUriForPath

(

string

path

)

Create Uri from a given file path.

The file path can be full with prefix or relative without prefix. If null is passed as the path, ArgumentException will be thrown.

Parameters

path

Returns

Delete()

void Org.Apache.REEF.IO.FileSystem.IFileSystem.Delete

(

Uri

fileUri

)

Deletes the file under the given URI.

Parameters

fileUri

Exceptions

IOException

DeleteDirectory()

void Org.Apache.REEF.IO.FileSystem.IFileSystem.DeleteDirectory

(

Uri

directoryUri

)

Deletes a directory.

Parameters

directoryUri

Exceptions

IOException

Exists()

bool Org.Apache.REEF.IO.FileSystem.IFileSystem.Exists

(

Uri

fileUri

)

Determines whether a file exists under the given URI.

Parameters

fileUri

Returns

GetChildren()

IEnumerable<Uri> Org.Apache.REEF.IO.FileSystem.IFileSystem.GetChildren

(

Uri

directoryUri

)

Get the children on the given URI, if that refers to a directory.

Parameters

directoryUri

Returns

Exceptions

IOException

GetFileStatus()

FileStatus Org.Apache.REEF.IO.FileSystem.IFileSystem.GetFileStatus

(

Uri

remoteFileUri

)

Gets the FileStatus for remote file.

Parameters

remoteFileUri

Exceptions

ArgumentNullException

If remote file URI is null

Returns

FileStatus

Open()

Stream Org.Apache.REEF.IO.FileSystem.IFileSystem.Open

(

Uri

fileUri

)

Opens the given URI for reading

Parameters

fileUri

Returns

Exceptions

IOException

If the URI couldn't be opened.

---

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

• lang/cs/Org.Apache.REEF.IO/FileSystem/IFileSystem.cs