Package org.eclipse.compare.internal

Class Utilities

java.lang.Object

org.eclipse.compare.internal.Utilities

public class Utilities
extends Object

Convenience and utility methods.

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	RUNNING_TESTS	Constant used to indicate that tests are being run.
static boolean	TESTING_FLUSH_ON_COMPARE_INPUT_CHANGE	Constant used while testing the indicate that changes should be flushed when the compare input changes and a viewer is dirty.

Constructor Summary

Constructors

Constructor	Description
Utilities()

Method Summary

Modifier and Type	Method	Description
static String	applyCompareFilters(String thisLine, char thisContributor, String otherLine, char otherContributor, ICompareFilter[] filters)	Applies the compare filters to the lines of text taken from the specified contributors
static void	close(InputStream is)
static void	executeRunnable(IRunnableWithProgress runnable)	Executes the given runnable.
static void	executeRunnable(IRunnableWithProgress runnable, boolean fork, boolean cancelable)	Executes the given runnable.
static IActionBars	findActionBars(Control c)
static IWorkbenchPartSite	findSite(Control c)
static void	firePropertyChange(ListenerList<IPropertyChangeListener> listenerList, Object source, String property, Object old, Object newValue)
static void	firePropertyChange(ListenerList<IPropertyChangeListener> listenerList, PropertyChangeEvent event)
static boolean	getBoolean(CompareConfiguration cc, String key, boolean dflt)
static byte[]	getBytes(String s, String encoding)
static String	getCharset(Object resource)
static ICompareFilter[]	getCompareFilters(CompareConfiguration cc)	Returns the active compare filters for the compare configuration
static IDocument	getDocument(char type, Object element, boolean isUsingDefaultContentProvider, boolean canHaveSharedDocument)
static IFile[]	getFiles(ISelection selection)
static IResource	getFirstResource(ISelection selection)
static String	getFormattedString(String key, String arg)
static String	getFormattedString(String key, String arg0, String arg1)
static String	getFormattedString(ResourceBundle bundle, String key, String arg)
static IPath	getIconPath(Display display)
static int	getInteger(ResourceBundle bundle, String key, int dfltValue)
static ITypedElement	getLeg(char type, Object input)
static IResource[]	getResources(ISelection selection)
static String	getString(String key)
static String	getString(ResourceBundle bundle, String key)
static String	getString(ResourceBundle bundle, String key, String dfltValue)
static String	getURLContents(URL url, IRunnableContext context)	Loads content of file under url displaying progress on given context.
static void	initAction(IAction a, ResourceBundle bundle, String prefix)
static void	initToggleAction(IAction a, ResourceBundle bundle, String prefix, boolean checked)
static boolean	isHunk(Object input)	Return whether either the left or right sides of the given input represents a hunk.
static boolean	isHunkOk(Object input)
static boolean	okToUse(Widget widget)
static String	readString(InputStream is, String encoding)
static String	readString(InputStream is, String encoding, int length, IProgressMonitor monitor)
static String	readString(IStreamContentAccessor sa)
static String	readString(IStreamContentAccessor sca, String encoding)
static void	runInUIThread(Runnable runnable)
static void	schedule(Job job, IWorkbenchSite site)
static void	setEnableComposite(Composite composite, boolean enable)
static void	setMenuImage(Item item)	Sets the menu image for the given Item.
static boolean	setReadTimeout(URLConnection connection, int timeout)
static boolean	validateResource(IResource resource, Shell shell, String title)
static boolean	validateResources(List<IResource> resources, Shell shell, String title)
static boolean	validateResources(IResource[] resources, Shell shell, String title)

Methods inherited from class java.lang.Object

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

Field Details

RUNNING_TESTS

public static boolean RUNNING_TESTS

Constant used to indicate that tests are being run.

TESTING_FLUSH_ON_COMPARE_INPUT_CHANGE

public static boolean TESTING_FLUSH_ON_COMPARE_INPUT_CHANGE

Constant used while testing the indicate that changes should be flushed when the compare input changes and a viewer is dirty.

Constructor Details

Utilities

public Utilities()

Method Details

findSite

public static IWorkbenchPartSite findSite(Control c)

findActionBars

public static IActionBars findActionBars(Control c)

setEnableComposite

public static void setEnableComposite(Composite composite,
 boolean enable)

getBoolean

public static boolean getBoolean(CompareConfiguration cc,
 String key,
 boolean dflt)

getCompareFilters

public static ICompareFilter[] getCompareFilters(CompareConfiguration cc)

Returns the active compare filters for the compare configuration

Returns:

the active compare filters

firePropertyChange

public static void firePropertyChange(ListenerList<IPropertyChangeListener> listenerList,
 Object source,
 String property,
 Object old,
 Object newValue)

firePropertyChange

public static void firePropertyChange(ListenerList<IPropertyChangeListener> listenerList,
 PropertyChangeEvent event)

okToUse

public static boolean okToUse(Widget widget)

getResources

public static IResource[] getResources(ISelection selection)

getFiles

public static IFile[] getFiles(ISelection selection)

getIconPath

public static IPath getIconPath(Display display)

initAction

public static void initAction(IAction a,
 ResourceBundle bundle,
 String prefix)

initToggleAction

public static void initToggleAction(IAction a,
 ResourceBundle bundle,
 String prefix,
 boolean checked)

getString

public static String getString(ResourceBundle bundle,
 String key,
 String dfltValue)

getFormattedString

public static String getFormattedString(ResourceBundle bundle,
 String key,
 String arg)

getString

public static String getString(String key)

getFormattedString

public static String getFormattedString(String key,
 String arg)

getFormattedString

public static String getFormattedString(String key,
 String arg0,
 String arg1)

getString

public static String getString(ResourceBundle bundle,
 String key)

getInteger

public static int getInteger(ResourceBundle bundle,
 String key,
 int dfltValue)

validateResource

public static boolean validateResource(IResource resource,
 Shell shell,
 String title)

validateResources

public static boolean validateResources(List<IResource> resources,
 Shell shell,
 String title)

validateResources

public static boolean validateResources(IResource[] resources,
 Shell shell,
 String title)

readString

public static String readString(IStreamContentAccessor sca,
 String encoding)
                         throws CoreException

Throws:

CoreException

readString

public static String readString(InputStream is,
 String encoding)
                         throws IOException

Throws:

IOException

readString

public static String readString(InputStream is,
 String encoding,
 int length,
 IProgressMonitor monitor)
                         throws IOException

Throws:

IOException

getCharset

public static String getCharset(Object resource)

getBytes

public static byte[] getBytes(String s,
 String encoding)

readString

public static String readString(IStreamContentAccessor sa)
                         throws CoreException

Throws:

CoreException

close

public static void close(InputStream is)

getFirstResource

public static IResource getFirstResource(ISelection selection)

getLeg

public static ITypedElement getLeg(char type,
 Object input)

getDocument

public static IDocument getDocument(char type,
 Object element,
 boolean isUsingDefaultContentProvider,
 boolean canHaveSharedDocument)

isHunk

public static boolean isHunk(Object input)

Return whether either the left or right sides of the given input represents a hunk. A hunk is a portion of a file.

Parameters:

input - the compare input

Returns:

whether the left or right side of the input represents a hunk

isHunkOk

public static boolean isHunkOk(Object input)

schedule

public static void schedule(Job job,
 IWorkbenchSite site)

runInUIThread

public static void runInUIThread(Runnable runnable)

setReadTimeout

public static boolean setReadTimeout(URLConnection connection,
 int timeout)

Parameters:

connection - a connection for which the timeout is set

timeout - an int that specifies the connect timeout value in milliseconds

Returns:

whether the timeout has been successfully set

getURLContents

public static String getURLContents(URL url,
 IRunnableContext context)
                             throws InvocationTargetException,
OperationCanceledException,
InterruptedException

Loads content of file under url displaying progress on given context.

Returns:

the content of file under given URL, or null if URL could not be loaded

Throws:

InvocationTargetException - thrown on errors while URL loading

OperationCanceledException

InterruptedException

applyCompareFilters

public static String applyCompareFilters(String thisLine,
 char thisContributor,
 String otherLine,
 char otherContributor,
 ICompareFilter[] filters)

Applies the compare filters to the lines of text taken from the specified contributors

Parameters:

filters - may be null

Returns:

returns the result of applying the filters to the line from the contributor

executeRunnable

public static void executeRunnable(IRunnableWithProgress runnable)
                            throws InvocationTargetException,
InterruptedException

Executes the given runnable. Uses the IProgressService if available.

Parameters:

runnable - The IRunnableWithProgress to execute.

Throws:

InvocationTargetException

InterruptedException

executeRunnable

public static void executeRunnable(IRunnableWithProgress runnable,
 boolean fork,
 boolean cancelable)
                            throws InvocationTargetException,
InterruptedException

Executes the given runnable. Uses the IProgressService if available.

Parameters:

runnable - The IRunnableWithProgress to execute.

fork - indicates whether to run within a separate thread.

cancelable - indicates whether the operation shall be cancelable

Throws:

InvocationTargetException

InterruptedException

setMenuImage

public static void setMenuImage(Item item)

Sets the menu image for the given Item. Uses the workbench shared image if available, otherwise creates a new image and adds a dispose listener.

Parameters:

item - The Item for which the menu image is to be set.