review.classdesign.jammy.common

Class EclipseUtils

java.lang.Object

review.classdesign.jammy.common.EclipseUtils

public final class EclipseUtils
extends java.lang.Object

Toolbox class that contains helpful method for dealing with Eclipse workbench features.

Author:

fv

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CANNOT_OPEN_FILE Error message displayed when a file could not be opened.
private static java.lang.String	COMMAND_ERROR Error message displayed when an error occurs while executing a command.
static org.eclipse.core.runtime.IProgressMonitor	NULL_MONITOR NullProgressMonitor instance shared in order to avoid instance duplication.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	EclipseUtils() Private constructor for avoiding instantiation.

Method Summary

Modifier and Type	Method and Description
static void	executeCommand(java.lang.String commandId) Executes the command denoted by the given commandId.
private static java.lang.String	getContent(org.eclipse.core.resources.IFile file) Retrieves the content as a String of the given file
static java.util.Optional<org.eclipse.core.resources.IFile>	getCurrentFile() Retrieves file instance that is currently edited.
static java.lang.String	getCurrentUser() Retrieves the current user name.
static org.eclipse.core.resources.IFolder	getFolder(org.eclipse.core.resources.IProject project, java.lang.String path) Retrieves folder denoted by the given path from the given project.
static org.eclipse.core.resources.IFolder	getFolder(org.eclipse.core.resources.IProject project, java.lang.String path, org.eclipse.core.runtime.IProgressMonitor monitor) Retrieves folder denoted by the given path from the given project.
static boolean	isFileEquals(org.eclipse.core.resources.IFile expected, org.eclipse.core.resources.IFile actual) Compares and indicates if both given files are equals or not.
static void	openFile(org.eclipse.core.resources.IFile file) Opens the given file into a default editor based on file nature.
static void	showError(java.lang.String message, java.lang.Exception execption) Handles the given exception by displaying it to user using eclipse status.

Methods inherited from class java.lang.Object

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

Field Detail

CANNOT_OPEN_FILE

private static final java.lang.String CANNOT_OPEN_FILE

Error message displayed when a file could not be opened.

See Also:

Constant Field Values

COMMAND_ERROR

private static final java.lang.String COMMAND_ERROR

Error message displayed when an error occurs while executing a command.

See Also:

Constant Field Values

NULL_MONITOR

public static final org.eclipse.core.runtime.IProgressMonitor NULL_MONITOR

NullProgressMonitor instance shared in order to avoid instance duplication.

Constructor Detail

EclipseUtils

private EclipseUtils()

Private constructor for avoiding instantiation.

Method Detail

getCurrentUser

public static java.lang.String getCurrentUser()

Retrieves the current user name.

Returns:

Current user nickname.

showError

public static void showError(java.lang.String message,
                             java.lang.Exception execption)

Handles the given exception by displaying it to user using eclipse status.

Parameters:

message - Error message that should be displayed.

execption - Error caught that should be logged.

getContent

private static java.lang.String getContent(org.eclipse.core.resources.IFile file)
                                    throws org.eclipse.core.runtime.CoreException,
                                           java.io.IOException

Retrieves the content as a String of the given file

Parameters:

file - File to retrieve content from.

Returns:

Content of the given file.

Throws:

org.eclipse.core.runtime.CoreException - If any error occurs while reading the file content.

java.io.IOException - If any error occurs while colsing file input stream.

isFileEquals

public static boolean isFileEquals(org.eclipse.core.resources.IFile expected,
                                   org.eclipse.core.resources.IFile actual)
                            throws org.eclipse.core.runtime.CoreException,
                                   java.io.IOException

Compares and indicates if both given files are equals or not.

Parameters:

expected - File that is containing expected content.

actual - File that is compared to the expected one.

Returns:

true if both file have the same content, false otherwise.

Throws:

org.eclipse.core.runtime.CoreException - If any error occurs while reading file content.

java.io.IOException

getFolder

public static org.eclipse.core.resources.IFolder getFolder(org.eclipse.core.resources.IProject project,
                                                           java.lang.String path)
                                                    throws org.eclipse.core.runtime.CoreException

Retrieves folder denoted by the given path from the given project. If the folder does not exist, it will be created using a default NullProgressMonitor before to be returned.

Parameters:

project - Project to retrieve folder from.

path - Project relative path of the folder to retrieve.

Returns:

Retrieved folder.

Throws:

org.eclipse.core.runtime.CoreException - If any error occurs while creating folder when required.

getFolder

public static org.eclipse.core.resources.IFolder getFolder(org.eclipse.core.resources.IProject project,
                                                           java.lang.String path,
                                                           org.eclipse.core.runtime.IProgressMonitor monitor)
                                                    throws org.eclipse.core.runtime.CoreException

Retrieves folder denoted by the given path from the given project. If the folder does not exist, it will be created before to be returned.

Parameters:

project - Project to retrieve folder from.

path - Project relative path of the folder to retrieve.

monitor - Monitor instance to use when creating folder.

Returns:

Retrieved folder.

Throws:

org.eclipse.core.runtime.CoreException - If any error occurs while creating folder when required.

executeCommand

public static void executeCommand(java.lang.String commandId)

Executes the command denoted by the given commandId.

Parameters:

commandId - Identifier of the command to execute.

openFile

public static void openFile(org.eclipse.core.resources.IFile file)

Opens the given file into a default editor based on file nature.

Parameters:

file - File to open in an editor.

getCurrentFile

public static java.util.Optional<org.eclipse.core.resources.IFile> getCurrentFile()

Retrieves file instance that is currently edited. File is returned as an Optional reference.

Returns:

Current edited file.