org.polarsys.capella.common.mdsofa.common.helper

Class FileHelper

java.lang.Object

org.polarsys.capella.common.mdsofa.common.helper.FileHelper

public class FileHelper
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FileHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	convertPackageNameToFolderPath(java.lang.String packageName_p) Convert package name to a correct java folder path.
static void	copyFile(java.lang.String sourceFileRelativePath_p, java.lang.String targetFileRelativePath_p) Copy given source file content in given target file.
static boolean	deleteFile(java.lang.String workspaceRelativeFile_p) Delete given relative file in the workspace.
static boolean	deleteFolder(java.lang.String workspaceRelativePath_p) Delete given relative folder in the workspace.
static void	ensurePathAvailability(java.lang.String fileFullPath_p) Make sure that given path is safe to use, ie ensure that all parent folders exist.
static boolean	exists(java.lang.String fileRelativePath_p) Is given file relative path pointing to an existing file ?
static java.io.InputStream	getFileAsStream(java.lang.String filePath_p) Get file as a stream.
static java.lang.String	getFileExtension(java.lang.String filePath_p) Returns the file extension portion for given file path, or null if there is none.
static org.eclipse.emf.common.util.URI	getFileFullUri(java.lang.String fileRelativePath_p) Get a file uri from relative one which is not resolved against the eclipse platform. The returned uri starts with either 'platform:/plug-in/' or 'platform:/resource/'.
static java.net.URL	getFileFullUrl(java.lang.String fileRelativePath_p) Get file full url from relative one.
static java.net.URL	getFileFullUrl(org.eclipse.emf.common.util.URI fileFullUri_p) Get file full url from its full uri. See getFileFullUri(String) method.
static IFile	getPlatformFile(java.lang.String fileRelativePath_p) Get platform file as an IResource from its relative path.
static IFolder	getPlatformFolder(java.lang.String folderRelativePath_p) Get platform folder as an IResource from its relative path.
static boolean	makeFileWritable(java.lang.String filePath_p) Make file writable. That is, make sure file is modifiable after this call. The user may be asked to take a decision if the file is held by the configuration management system. Nevertheless, if no UI is reachable, then the system is urged into making the file writable.
static boolean	moveResource(IResource resource_p, IPath destinationPath_p) Move resource to given destination path.
static byte[]	readFile(java.io.InputStream inputStream_p) Read given input stream as an array of bytes.
static java.lang.String	readFile(java.lang.String filePath_p) Read file as a string.
static byte[]	readRawFile(java.lang.String filePath_p) Read file as an array of bytes.
static boolean	renameFile(java.lang.String sourceFileRelativePath_p, java.lang.String destinationFileRelativePath_p) Rename file from source file relative path to destination relative path.
static boolean	renameFolder(java.lang.String sourceFolderRelativePath_p, java.lang.String destinationFolderRelativePath_p) Rename folder from source folder relative path to destination relative path.
static boolean	writeFile(java.lang.String filePath_p, boolean ensureFolders_p, byte[] contents_p) Write given contents of bytes at specified path.
static boolean	writeFile(java.lang.String filePath_p, boolean ensureFolders_p, java.lang.String contents_p) Write given string contents at specified path.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileHelper

public FileHelper()

Method Detail

getFileFullUrl

public static java.net.URL getFileFullUrl(java.lang.String fileRelativePath_p)

Get file full url from relative one.

Parameters:

fileRelativePath_p - File path relative to workspace.
It must start with pluginId or project name. It is also recommended that both plug-in id and plug-in project names are the same.
As a convenience, the full path will refer to the plug-in id.
Example : org.polarsys.capella.common.mdsofa/model/example.ecore is a path relative to the workspace that refers to the org.polarsys.capella.common.mdsofa plug-in, having a model/example.ecore file in its project.
In Eclipse resource system, such a path is considered as an absolute one against the workspace root.
It's still referred to as a relative path, since the returned URL is absolute in the file system.

Returns:

getFileFullUrl

public static java.net.URL getFileFullUrl(org.eclipse.emf.common.util.URI fileFullUri_p)

Get file full url from its full uri.
See getFileFullUri(String) method.

Parameters:

fileFullUri_p -

Returns:

getFileFullUri

public static org.eclipse.emf.common.util.URI getFileFullUri(java.lang.String fileRelativePath_p)

Get a file uri from relative one which is not resolved against the eclipse platform.
The returned uri starts with either 'platform:/plug-in/' or 'platform:/resource/'.

Parameters:

fileRelativePath_p - File path relative to workspace.
It must start with project name or pluginId. It is also recommended that both plug-in id and plug-in project names are the same.
As a convenience, the full path will refer to the plug-in id.
Example : org.polarsys.capella.common.mdsofa/model/example.ecore is a path relative to the workspace that refers to the org.polarsys.capella.common.mdsofa plug-in, having a model/example.ecore file in its project.

Returns:

an URI not resolved against the eclipse platform.

convertPackageNameToFolderPath

public static java.lang.String convertPackageNameToFolderPath(java.lang.String packageName_p)

Convert package name to a correct java folder path.

Parameters:

packageName_p -

Returns:

readFile

public static byte[] readFile(java.io.InputStream inputStream_p)

Read given input stream as an array of bytes.

Parameters:

inputStream_p -

Returns:

a not null array.

readFile

public static java.lang.String readFile(java.lang.String filePath_p)
                                 throws java.io.UnsupportedEncodingException

Read file as a string.

Parameters:

filePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

Returns:

If an error occurred ICommonConstants.EMPTY_STRING is returned.

Throws:

java.io.UnsupportedEncodingException

getFileAsStream

public static java.io.InputStream getFileAsStream(java.lang.String filePath_p)

Get file as a stream.

Parameters:

filePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

Returns:

If an error occurred null is returned.

readRawFile

public static byte[] readRawFile(java.lang.String filePath_p)

Read file as an array of bytes.

Parameters:

filePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

Returns:

a not null array.

copyFile

public static void copyFile(java.lang.String sourceFileRelativePath_p,
                            java.lang.String targetFileRelativePath_p)

Copy given source file content in given target file.

Parameters:

sourceFileRelativePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

targetFileRelativePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

writeFile

public static boolean writeFile(java.lang.String filePath_p,
                                boolean ensureFolders_p,
                                java.lang.String contents_p)

Write given string contents at specified path.

Parameters:

filePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

ensureFolders_p - Make sure all parent folders exist by creating all necessary ones.

contents_p - Contents that should be written to pointed file.

Returns:

writeFile

public static boolean writeFile(java.lang.String filePath_p,
                                boolean ensureFolders_p,
                                byte[] contents_p)

Write given contents of bytes at specified path.

Parameters:

filePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

ensureFolders_p - Make sure all parent folders exist by creating all necessary ones.

contents_p - Contents that should be written to pointed file.

Returns:

renameFile

public static boolean renameFile(java.lang.String sourceFileRelativePath_p,
                                 java.lang.String destinationFileRelativePath_p)

Rename file from source file relative path to destination relative path.

Parameters:

sourceFileRelativePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

destinationFileRelativePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

Returns:

renameFolder

public static boolean renameFolder(java.lang.String sourceFolderRelativePath_p,
                                   java.lang.String destinationFolderRelativePath_p)

Rename folder from source folder relative path to destination relative path.

Parameters:

sourceFolderRelativePath_p - Folder path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

destinationFolderRelativePath_p - Folder path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

Returns:

moveResource

public static boolean moveResource(IResource resource_p,
                                   IPath destinationPath_p)

Move resource to given destination path.

Parameters:

resource_p -

destinationPath_p -

Returns:

true if move occurred with no exception, false otherwise.

exists

public static boolean exists(java.lang.String fileRelativePath_p)

Is given file relative path pointing to an existing file ?

Parameters:

fileRelativePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

Returns:

ensurePathAvailability

public static void ensurePathAvailability(java.lang.String fileFullPath_p)

Make sure that given path is safe to use, ie ensure that all parent folders exist.

Parameters:

fileFullPath_p -

deleteFile

public static boolean deleteFile(java.lang.String workspaceRelativeFile_p)

Delete given relative file in the workspace.

Parameters:

workspaceRelativeFile_p -

deleteFolder

public static boolean deleteFolder(java.lang.String workspaceRelativePath_p)

Delete given relative folder in the workspace.

Parameters:

workspaceRelativePath_p -

Returns:

true if successfully deleted, false otherwise.

getPlatformFile

public static IFile getPlatformFile(java.lang.String fileRelativePath_p)

Get platform file as an IResource from its relative path.

Parameters:

fileRelativePath_p - File path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

Returns:

getPlatformFolder

public static IFolder getPlatformFolder(java.lang.String folderRelativePath_p)

Get platform folder as an IResource from its relative path.

Parameters:

folderRelativePath_p - Folder path relative to the plug-in, plug-in id included.
See getFileFullUrl(String) documentation.

Returns:

getFileExtension

public static java.lang.String getFileExtension(java.lang.String filePath_p)

Returns the file extension portion for given file path,
or null if there is none.

The file extension portion is defined as the string
following the last period (".") character in the last segment.
If there is no period in the last segment, the path has no
file extension portion. If the last segment ends in a period,
the file extension portion is the empty string.

Parameters:

filePath_p -

Returns:

the file extension or null

makeFileWritable

public static boolean makeFileWritable(java.lang.String filePath_p)

Make file writable.
That is, make sure file is modifiable after this call.
The user may be asked to take a decision if the file is held by the configuration management system.
Nevertheless, if no UI is reachable, then the system is urged into making the file writable.

Parameters:

filePath_p - File path relative to the plug-in, plug-in id included. See getFileFullUrl(String) documentation.

Returns:

false if file could not be made writable or user denied rights to (in case of a configuration management). true if it does not exist (then it is writable) or permission was granted (either by the system or by the user).