Package org.eclipse.jface.util

Class Util

  • public final class Util
extends Object

    A static class providing utility methods to all of JFace.

    Since:
    3.1

    • Method Detail

      • assertInstance

        public static void assertInstance​(Object object,
                                  Class<?> c)
        Verifies that the given object is an instance of the given class.
        Parameters:
        object - The object to check; may be null.
        c - The class which the object should be; must not be null.

      • compare

        public static int compare​(boolean left,
                          boolean right)
        Compares two boolean values. false is considered to be "less than" true.
        Parameters:
        left - The left value to compare
        right - The right value to compare
        Returns:
        -1 if the left is false and the right is true. 1 if the opposite is true. If they are equal, then it returns 0.

      • compare

        public static int compare​(int left,
                          int right)
        Compares two integer values.
        Parameters:
        left - The left value to compare
        right - The right value to compare
        Returns:
        left - right

      • compare

        public static <T extends Comparable<? super T>> int compare​(T left,
                                                            T right)
        Compares to comparable objects -- defending against null.
        Parameters:
        left - The left object to compare; may be null.
        right - The right object to compare; may be null.
        Returns:
        The result of the comparison. null is considered to be the least possible value.

      • compare

        public static <T extends Comparable<? super T>> int compare​(T[] left,
                                                            T[] right)
        Compares two arrays of comparable objects -- accounting for null.
        Parameters:
        left - The left array to be compared; may be null.
        right - The right array to be compared; may be null.
        Returns:
        The result of the comparison. null is considered to be the least possible value. A shorter array is considered less than a longer array.

      • compare

        public static <T extends Comparable<? super T>> int compare​(List<T> left,
                                                            List<T> right)
        Compares two lists -- account for null. The lists must contain comparable objects.
        Parameters:
        left - The left list to compare; may be null. This list must only contain instances of Comparable.
        right - The right list to compare; may be null. This list must only contain instances of Comparable.
        Returns:
        The result of the comparison. null is considered to be the least possible value. A shorter list is considered less than a longer list.

      • endsWith

        public static boolean endsWith​(Object[] left,
                               Object[] right,
                               boolean equals)
        Tests whether the first array ends with the second array.
        Parameters:
        left - The array to check (larger); may be null.
        right - The array that should be a subsequence (smaller); may be null.
        equals - Whether the two array are allowed to be equal.
        Returns:
        true if the second array is a subsequence of the array list, and they share end elements.

      • equals

        @Deprecated
public static boolean equals​(Object left,
                             Object right)
        Deprecated.
        Use Objects.equals(Object, Object)
        Checks whether the two objects are null -- allowing for null.
        Parameters:
        left - The left object to compare; may be null.
        right - The right object to compare; may be null.
        Returns:
        true if the two objects are equivalent; false otherwise.

      • equals

        @Deprecated
public static boolean equals​(Object[] leftArray,
                             Object[] rightArray)
        Deprecated.
        Use Arrays.equals(Object[], Object[])
        Tests whether two arrays of objects are equal to each other. The arrays must not be null, but their elements may be null.
        Parameters:
        leftArray - The left array to compare; may be null, and may be empty and may contain null elements.
        rightArray - The right array to compare; may be null, and may be empty and may contain null elements.
        Returns:
        true if the arrays are equal length and the elements at the same position are equal; false otherwise.

      • hashCode

        @Deprecated
public static int hashCode​(int i)
        Deprecated.
        return directly value, or use Integer.hashCode(int)
        Provides a hash code based on the given integer value.
        Parameters:
        i - The integer value
        Returns:
        i

      • hashCode

        @Deprecated
public static int hashCode​(Object object)
        Deprecated.
        use Objects.hashCode(Object)
        Provides a hash code for the object -- defending against null.
        Parameters:
        object - The object for which a hash code is required.
        Returns:
        object.hashCode or 0 if object if null.

      • hashCode

        @Deprecated
public static int hashCode​(Object[] objects)
        Deprecated.
        use Arrays.hashCode(Object[])
        Computes the hash code for an array of objects, but with defense against null.
        Parameters:
        objects - The array of objects for which a hash code is needed; may be null.
        Returns:
        The hash code for objects; or 0 if objects is null.

      • startsWith

        public static boolean startsWith​(Object[] left,
                                 Object[] right,
                                 boolean equals)
        Checks whether the second array is a subsequence of the first array, and that they share common starting elements.
        Parameters:
        left - The first array to compare (large); may be null.
        right - The second array to compare (small); may be null.
        equals - Whether it is allowed for the two arrays to be equivalent.
        Returns:
        true if the first arrays starts with the second list; false otherwise.

      • toString

        public static String toString​(Object[] array)
        Converts an array into a string representation that is suitable for debugging.
        Parameters:
        array - The array to convert; may be null.
        Returns:
        The string representation of the array; never null.

      • translateString

        public static String translateString​(ResourceBundle resourceBundle,
                                     String key,
                                     String defaultString)
        Provides a translation of a particular key from the resource bundle.
        Parameters:
        resourceBundle - The key to look up in the resource bundle; should not be null.
        key - The key to look up in the resource bundle; should not be null.
        defaultString - The value to return if the resource cannot be found; may be null.
        Returns:
        The value of the translated resource at key. If the key cannot be found, then it is simply the defaultString.

      • replaceAll

        public static String replaceAll​(String src,
                                String find,
                                String replacement)
        Foundation replacement for String#replaceAll(String, String), but without support for regular expressions.
        Parameters:
        src - the original string
        find - the string to find
        replacement - the replacement string
        Returns:
        the new string, with all occurrences of find replaced by replacement (not using regular expressions)
        Since:
        3.4

      • isWindows

        public static boolean isWindows()
        Common WS query helper method.
        Returns:
        true for windows platforms
        Since:
        3.5

      • isMac

        public static boolean isMac()
        Common WS query helper method.
        Returns:
        true for mac platforms
        Since:
        3.5

      • isLinux

        public static boolean isLinux()
        Common WS query helper method.
        Returns:
        true for linux platform
        Since:
        3.5

      • isGtk

        public static boolean isGtk()
        Common WS query helper method.
        Returns:
        true for gtk platforms
        Since:
        3.5

      • isMotif

        @Deprecated
public static boolean isMotif()
        Deprecated.
        Common WS query helper method.
        Returns:
        true for motif platforms
        Since:
        3.5

      • isPhoton

        @Deprecated
public static boolean isPhoton()
        Deprecated.
        Common WS query helper method.
        Returns:
        true for photon platforms
        Since:
        3.5

      • isCarbon

        @Deprecated
public static boolean isCarbon()
        Deprecated.
        Common WS query helper method.
        Returns:
        true for carbon platforms
        Since:
        3.5

      • isCocoa

        public static boolean isCocoa()
        Common WS query helper method.
        Returns:
        true for the cocoa platform.
        Since:
        3.5

      • isWpf

        public static boolean isWpf()
        Common WS query helper method.
        Returns:
        true for WPF
        Since:
        3.5

      • isWin32

        public static boolean isWin32()
        Common WS query helper method.
        Returns:
        true for win32
        Since:
        3.5

      • getWS

        public static String getWS()
        Common WS query helper method.
        Returns:
        the SWT windowing platform string.
        Since:
        3.5
        See Also:
        SWT.getPlatform()

      • getClosestMonitor

        public static Monitor getClosestMonitor​(Display toSearch,
                                        Point toFind)
        Returns the monitor whose client area contains the given point. If no monitor contains the point, returns the monitor that is closest to the point. If this is ever made public, it should be moved into a separate utility class.
        Parameters:
        toSearch - point to find (display coordinates)
        toFind - point to find (display coordinates)
        Returns:
        the monitor closest to the given point
        Since:
        3.15

      • isValid

        public static boolean isValid​(Widget widget)
        Helper method to check if a widget is not null and not disposed
        Parameters:
        widget - to be checked
        Returns:
        true if widget is not disposed or null, false otherwise
        Since:
        3.22