Package ch.nolix.core.environment.filesystem

Klasse FolderAccessor

java.lang.Object

ch.nolix.core.environment.filesystem.FileSystemItemAccessorUnit

ch.nolix.core.environment.filesystem.FolderAccessor

public final class FolderAccessor
extends FileSystemItemAccessorUnit

A FolderAccessor can access a folder.

Version:

2017-07-10

Autor:

Silvan Wyss

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
FolderAccessor()	Creates a new FolderAccessor for the folder of the running jar file.
FolderAccessor(String path)	Creates a new FolderAccessor for the folder with the given path.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
boolean	containsItem(String relativePath)
FileAccessor	createFile(String relativePath)	Creates a new empty file with the given relative path in the folder of the current FolderAccessor.
FolderAccessor	createFolder(String relativePath)	Creates a new empty folder with the given relative path in the folder of the current FolderAccessor.
void	deleteFileSystemItem(String relativePath)	Deletes the file system item with the given relative path from the folder of the current FolderAccessor if it exists.
IContainer<FileAccessor>	getFileAccessors()
IContainer<FileAccessor>	getFileAccessors(String extension)
ILinkedList<FileAccessor>	getFileAccessorsRecursively()
IContainer<FileAccessor>	getFileAccessorsRecursively(String extension)
IContainer<FileSystemItemAccessorUnit>	getFileSystemItemAccessors()
FolderAccessor	getFolderAccessor(String relativePath)
void	openInFileExplorer()	Opens the folder of the current FolderAccessor in a new file explorer.
String	readFile(String relativePath)	Reads the content of the file with the given relative path.

Von Klasse geerbte Methoden ch.nolix.core.environment.filesystem.FileSystemItemAccessorUnit

getExtension, getInternalAccessor, getName, getParentFolderAccessor, getPath, getSizeInBytes, hasExtension, isFile, isFolder, openParentFolder

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

FolderAccessor

public FolderAccessor()

Creates a new FolderAccessor for the folder of the running jar file.

FolderAccessor

public FolderAccessor(String path)

Creates a new FolderAccessor for the folder with the given path.

Parameter:

path -

Löst aus:

InvalidArgumentException - if there does not exist a folder with the given path in the file system on the local machine.

Methodendetails

containsItem

public boolean containsItem(String relativePath)

Parameter:

relativePath -

Gibt zurück:

true if the folder of the current FolderAccessor contains an item with the given relative path.

createFile

public FileAccessor createFile(String relativePath)

Creates a new empty file with the given relative path in the folder of the current FolderAccessor.

Parameter:

relativePath -

Gibt zurück:

a new FileAccessor for the created file.

Löst aus:

InvalidArgumentException - if there exists already a file system item with the given relative path in the folder of the current FolderAccessor.

createFolder

public FolderAccessor createFolder(String relativePath)

Creates a new empty folder with the given relative path in the folder of the current FolderAccessor.

Parameter:

relativePath -

Gibt zurück:

a new FolderAccessor for the created folder.

Löst aus:

InvalidArgumentException - if there exists alreay a file system item with the given relative path in the folder of the current FolderAccessor.

deleteFileSystemItem

public void deleteFileSystemItem(String relativePath)

Deletes the file system item with the given relative path from the folder of the current FolderAccessor if it exists.

Parameter:

relativePath -

getFileAccessors

public IContainer<FileAccessor> getFileAccessors()

Gibt zurück:

new FileAccessors for the files in the folder of the current FolderAccessor.

getFileAccessors

public IContainer<FileAccessor> getFileAccessors(String extension)

Parameter:

extension -

Gibt zurück:

a new FileAccessors for the files in the folder of the current FolderAccessor, that have the given extension.

getFileAccessorsRecursively

public IContainer<FileAccessor> getFileAccessorsRecursively(String extension)

Parameter:

extension -

Gibt zurück:

new FileAccessor for the files in the folder of the current FolderAccessor, that have the given extension, recursively.

getFileAccessorsRecursively

public ILinkedList<FileAccessor> getFileAccessorsRecursively()

Gibt zurück:

new FileAccessor for the files in the folder of the current FolderAccessor recursively.

getFileSystemItemAccessors

public IContainer<FileSystemItemAccessorUnit> getFileSystemItemAccessors()

Gibt zurück:

new FileSystemItemAccessorUnits to the file system items in the folder of the current FolderAccessor.

getFolderAccessor

public FolderAccessor getFolderAccessor(String relativePath)

Parameter:

relativePath -

Gibt zurück:

a new FolderAccessor for the folder with the given relative path in the folder of the current FolderAccessor.

openInFileExplorer

public void openInFileExplorer()

Opens the folder of the current FolderAccessor in a new file explorer.

readFile

public String readFile(String relativePath)

Reads the content of the file with the given relative path.

Parameter:

relativePath -

Gibt zurück:

the content of the file with the given relative path.

Löst aus:

InvalidArgumentException - if there does not exist a file with the given relative path in the folder of the current FolderAccessor.

RuntimeException - if an error occurs.