ptolemy.backtrack.eclipse.plugin.util

Class Environment

java.lang.Object

ptolemy.backtrack.eclipse.plugin.util.Environment

public class Environment
extends java.lang.Object

The class containing a set of static methods for the transformation environment.

Since:

Ptolemy II 5.1

Version:

$Id$

Author:

Thomas Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Red (tfeng)

Constructor Summary

Constructors

Constructor and Description
Environment()

Method Summary

Modifier and Type	Method and Description
static void	createFolders(org.eclipse.core.resources.IContainer container) Create the folder represented by the container object, and all its parent folders if necessary.
static org.eclipse.core.resources.IContainer	getAffectedFolder() Get the folder where all the transformed classes are placed.
static java.lang.String[]	getClassPaths(org.eclipse.swt.widgets.Shell shell) Get the default class paths.
static org.eclipse.core.resources.IContainer	getContainer(org.eclipse.core.runtime.IPath path) Given a path, return its container representation in Eclipse.
static java.lang.String	getPtolemyHome() Get the Ptolemy home.
static java.lang.String	getPtolemyHome(org.eclipse.swt.widgets.Shell shell) Get the Ptolemy home.
static org.eclipse.core.runtime.IPath	getRefactoredFile(java.lang.String source, java.lang.String packageName) Given the source name of a Java file and its package name, return the path to the transformed file with backtracking prefix added to it.
static java.lang.String	getRefactoringRoot() Get the root for the source transformer.
static java.lang.String	getRefactoringRoot(org.eclipse.swt.widgets.Shell shell) Get the root for the source transformer.
static java.lang.String	getSourceList() Get the file name of the refactoring source list.
static java.lang.String	getSourceList(org.eclipse.swt.widgets.Shell shell) Get the file name of the refactoring source list.
static boolean	setupTransformerArguments(org.eclipse.swt.widgets.Shell shell, boolean config, boolean alwaysOverwrite) Set up the transformation arguments according to the preferences set in the preference page.

Methods inherited from class java.lang.Object

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

Constructor Detail

Environment

public Environment()

Method Detail

createFolders

public static void createFolders(org.eclipse.core.resources.IContainer container)
                          throws org.eclipse.core.runtime.CoreException

Create the folder represented by the container object, and all its parent folders if necessary.

Parameters:

container - The container representing the folder to be created.

Throws:

org.eclipse.core.runtime.CoreException - If the folder creation fails.

getAffectedFolder

public static org.eclipse.core.resources.IContainer getAffectedFolder()

Get the folder where all the transformed classes are placed. It is a sub-folder rooted at the backtracking root (can be set in the preference page). The sub-path is appended to the root according to the backtracking prefix.

Returns:

The container representing the folder where all the transformed classes are placed.

getClassPaths

public static java.lang.String[] getClassPaths(org.eclipse.swt.widgets.Shell shell)

Get the default class paths.

Parameters:

shell - The shell object.

Returns:

The array of class paths, or null if Ptolemy is not found.

getContainer

public static org.eclipse.core.resources.IContainer getContainer(org.eclipse.core.runtime.IPath path)

Given a path, return its container representation in Eclipse.

Parameters:

path - The path.

Returns:

The container, or null if the path is invalid.

getPtolemyHome

public static java.lang.String getPtolemyHome()

Get the Ptolemy home.

Returns:

The Ptolemy home, or null if Ptolemy is not found.

getPtolemyHome

public static java.lang.String getPtolemyHome(org.eclipse.swt.widgets.Shell shell)

Get the Ptolemy home. If Ptolemy cannot be found, an error message is popped up in the given shell.

Parameters:

shell - The shell.

Returns:

The Ptolemy home, or null if Ptolemy is not found.

getRefactoredFile

public static org.eclipse.core.runtime.IPath getRefactoredFile(java.lang.String source,
                                                               java.lang.String packageName)

Given the source name of a Java file and its package name, return the path to the transformed file with backtracking prefix added to it.

Parameters:

source - The Java source file.

packageName - The package name.

Returns:

The path to the transformed file.

getRefactoringRoot

public static java.lang.String getRefactoringRoot()

Get the root for the source transformer. This root can be set in the preference page.

Returns:

The root, or null if the root is invalid.

getRefactoringRoot

public static java.lang.String getRefactoringRoot(org.eclipse.swt.widgets.Shell shell)

Get the root for the source transformer. This root can be set in the preference page. If the root is invalid, an error message is popped up in the given shell.

Parameters:

shell - The shell.

Returns:

The root, or null if the root is invalid.

getSourceList

public static java.lang.String getSourceList()

Get the file name of the refactoring source list.

Returns:

The file name of the refactoring source list, or null if the source list is invalid.

getSourceList

public static java.lang.String getSourceList(org.eclipse.swt.widgets.Shell shell)

Get the file name of the refactoring source list. If the source list is invalid, an error message is popped up in the given shell.

Parameters:

shell - The shell.

Returns:

The file name of the refactoring source list.

setupTransformerArguments

public static boolean setupTransformerArguments(org.eclipse.swt.widgets.Shell shell,
                                                boolean config,
                                                boolean alwaysOverwrite)

Set up the transformation arguments according to the preferences set in the preference page. Static fields of the transformer are initialized with these arguments.

Parameters:

shell - The shell.

config - Whether to generate MoML configuration.

alwaysOverwrite - Whether to overwrite existing files.

Returns:

false if the Refactoring root cannot be found, true otherwise.