com.sap.client.odata.v4.file

Class FileManager

java.lang.Object

com.sap.client.odata.v4.file.FileManager

public abstract class FileManager
extends java.lang.Object

Utility functions for managing files and directories.

Constructor Summary

Constructors

Constructor and Description
FileManager()

Method Summary

Modifier and Type	Method and Description
static void	copyFile(java.lang.String source, java.lang.String target) Copy source file to target file.
static void	createDirectory(java.lang.String file) See createDirectory(String, boolean).
static void	createDirectory(java.lang.String file, boolean createParents) Create a directory file.
static void	createParent(java.lang.String file) Create parent directory for a file, if the parent directory doesn't exist already.
static void	deleteDirectory(java.lang.String file) See deleteDirectory(String, boolean).
static void	deleteDirectory(java.lang.String file, boolean deleteChildren) Delete a directory file.
static void	deleteFile(java.lang.String file) Delete file.
static boolean	fileExists(java.lang.String file) Check if file exists.
static long	fileLength(java.lang.String file) Return the length of an existing file.
static boolean	isDirectory(java.lang.String file) Check if a file name represents an existing directory.
static StringList	listFiles(java.lang.String path) Return a list of the files in a directory
static java.lang.String	localDirectory() Get the current application's preferred local directory name, or current directory name on platforms with no concept of the application's local directory.
static java.lang.String	parentDirectory(java.lang.String file) Return (nullable) The parent directory for file, or null if the file has no parent directory.
static void	renameFile(java.lang.String oldName, java.lang.String newName) Rename a file from oldName to newName.
static java.lang.String	resolveName(java.lang.String file) Convert a file name to canonical/preferred syntax for the file system.
static java.lang.String	unqualifiedName(java.lang.String file) Return the unqualified name of file, excluding any parent directories.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileManager

public FileManager()

Method Detail

copyFile

public static void copyFile(java.lang.String source,
                            java.lang.String target)

Copy source file to target file.

Parameters:

source - Source file name.

target - Target file name.

createDirectory

public static void createDirectory(java.lang.String file)

See createDirectory(String, boolean).

createDirectory

public static void createDirectory(java.lang.String file,
                                   boolean createParents)

Create a directory file.

Parameters:

file - Directory file name.

createParents - Should parent directories be created if they don't already exist? Defaults to true.

createParent

public static void createParent(java.lang.String file)

Create parent directory for a file, if the parent directory doesn't exist already.

Parameters:

file - File name.

deleteDirectory

public static void deleteDirectory(java.lang.String file)

See deleteDirectory(String, boolean).

deleteDirectory

public static void deleteDirectory(java.lang.String file,
                                   boolean deleteChildren)

Delete a directory file.

Parameters:

file - Directory file name.

deleteChildren - Should child files and directories be deleted if they exist? Defaults to true.

deleteFile

public static void deleteFile(java.lang.String file)

Delete file.

Parameters:

file - File name.

fileExists

public static boolean fileExists(java.lang.String file)

Check if file exists.

Parameters:

file - File name.

Returns:

true if the file (or directory) exists, false otherwise.

fileLength

public static long fileLength(java.lang.String file)

Return the length of an existing file.

Parameters:

file - File name.

Returns:

The length of an existing file.

isDirectory

public static boolean isDirectory(java.lang.String file)

Check if a file name represents an existing directory.

Parameters:

file - File name.

Returns:

true if the represents an existing directory, otherwise false.

listFiles

public static StringList listFiles(java.lang.String path)

Return a list of the files in a directory

Parameters:

path - Directory name.

Returns:

A list of the files in a directory

localDirectory

public static java.lang.String localDirectory()

Get the current application's preferred local directory name, or current directory name on platforms with no concept of the application's local directory.

parentDirectory

public static java.lang.String parentDirectory(java.lang.String file)

Return (nullable) The parent directory for file, or null if the file has no parent directory.

Parameters:

file - File name.

Returns:

(nullable) The parent directory for file, or null if the file has no parent directory.

renameFile

public static void renameFile(java.lang.String oldName,
                              java.lang.String newName)

Rename a file from oldName to newName.

Parameters:

oldName - Original file name.

newName - New file name.

resolveName

public static java.lang.String resolveName(java.lang.String file)

Convert a file name to canonical/preferred syntax for the file system.

Parameters:

file - File name.

unqualifiedName

public static java.lang.String unqualifiedName(java.lang.String file)

Return the unqualified name of file, excluding any parent directories.

Parameters:

file - File name.

Returns:

The unqualified name of file, excluding any parent directories.