Package org.eclipse.jface.util
Class Util
java.lang.Object
org.eclipse.jface.util.Util
A static class providing utility methods to all of JFace.
- Since:
- 3.1
-
Field Summary
Modifier and TypeFieldDescriptionstatic final SortedSet<?>
An unmodifiable, empty, sorted set.static final String
Deprecated.static final String
Windowing system constant.static final String
Windowing system constant.static final String
Deprecated.static final String
Deprecated.static final String
Windowing system constant.static final String
Windowing system constant.static final String
Windowing system constant.static final String
A common zero-length string. -
Method Summary
Modifier and TypeMethodDescriptionstatic void
assertInstance
(Object object, Class<?> c) Verifies that the given object is an instance of the given class.static int
compare
(boolean left, boolean right) Compares two boolean values.static int
compare
(int left, int right) Compares two integer values.static <T extends Comparable<? super T>>
intCompares two lists -- account fornull
.static <T extends Comparable<? super T>>
intcompare
(T[] left, T[] right) Compares two arrays of comparable objects -- accounting fornull
.static <T extends Comparable<? super T>>
intcompare
(T left, T right) Compares to comparable objects -- defending againstnull
.static boolean
Tests whether the first array ends with the second array.static boolean
Deprecated.static boolean
Deprecated.static Monitor
getClosestMonitor
(Display toSearch, Point toFind) Returns the monitor whose client area contains the given point.static String
getWS()
Common WS query helper method.static int
hashCode
(int i) Deprecated.return directly value, or useInteger.hashCode(int)
static int
Deprecated.static int
Deprecated.static boolean
isCarbon()
Deprecated.static boolean
isCocoa()
Common WS query helper method.static boolean
isGtk()
Common WS query helper method.static boolean
isLinux()
Common WS query helper method.static boolean
isMac()
Common WS query helper method.static boolean
isMotif()
Deprecated.static boolean
isPhoton()
Deprecated.static boolean
Helper method to check if a widget is not null and not disposedstatic boolean
isWin32()
Common WS query helper method.static boolean
Common WS query helper method.static boolean
isWpf()
Common WS query helper method.static String
replaceAll
(String src, String find, String replacement) Foundation replacement forString#replaceAll(String, String)
, but without support for regular expressions.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.static String
Converts an array into a string representation that is suitable for debugging.static String
translateString
(ResourceBundle resourceBundle, String key, String defaultString) Provides a translation of a particular key from the resource bundle.
-
Field Details
-
EMPTY_SORTED_SET
An unmodifiable, empty, sorted set. This value is guaranteed to never change and never benull
. -
ZERO_LENGTH_STRING
A common zero-length string. It avoids needing writeNON-NLS
next to code fragments. It's also a bit clearer to read.- See Also:
-
WS_WIN32
Windowing system constant.- Since:
- 3.5
- See Also:
-
WS_MOTIF
Deprecated.Windowing system constant.- Since:
- 3.5
- See Also:
-
WS_GTK
Windowing system constant.- Since:
- 3.5
- See Also:
-
WS_PHOTON
Deprecated.Windowing system constant.- Since:
- 3.5
- See Also:
-
WS_CARBON
Deprecated.Windowing system constant.- Since:
- 3.5
- See Also:
-
WS_COCOA
Windowing system constant.- Since:
- 3.5
- See Also:
-
WS_WPF
Windowing system constant.- Since:
- 3.5
- See Also:
-
WS_UNKNOWN
Windowing system constant.- Since:
- 3.5
- See Also:
-
-
Method Details
-
assertInstance
Verifies that the given object is an instance of the given class.- Parameters:
object
- The object to check; may benull
.c
- The class which the object should be; must not benull
.
-
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 compareright
- The right value to compare- Returns:
-1
if the left isfalse
and the right istrue
.1
if the opposite is true. If they are equal, then it returns0
.
-
compare
public static int compare(int left, int right) Compares two integer values.- Parameters:
left
- The left value to compareright
- The right value to compare- Returns:
left - right
-
compare
Compares to comparable objects -- defending againstnull
.- Parameters:
left
- The left object to compare; may benull
.right
- The right object to compare; may benull
.- Returns:
- The result of the comparison.
null
is considered to be the least possible value.
-
compare
Compares two arrays of comparable objects -- accounting fornull
.- Parameters:
left
- The left array to be compared; may benull
.right
- The right array to be compared; may benull
.- 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
Compares two lists -- account fornull
. The lists must contain comparable objects.- Parameters:
left
- The left list to compare; may benull
. This list must only contain instances ofComparable
.right
- The right list to compare; may benull
. This list must only contain instances ofComparable
.- 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
Tests whether the first array ends with the second array.- Parameters:
left
- The array to check (larger); may benull
.right
- The array that should be a subsequence (smaller); may benull
.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.Checks whether the two objects arenull
-- allowing fornull
.- Parameters:
left
- The left object to compare; may benull
.right
- The right object to compare; may benull
.- Returns:
true
if the two objects are equivalent;false
otherwise.
-
equals
Deprecated.Tests whether two arrays of objects are equal to each other. The arrays must not benull
, but their elements may benull
.- Parameters:
leftArray
- The left array to compare; may benull
, and may be empty and may containnull
elements.rightArray
- The right array to compare; may benull
, and may be empty and may containnull
elements.- Returns:
true
if the arrays are equal length and the elements at the same position are equal;false
otherwise.
-
hashCode
Deprecated.return directly value, or useInteger.hashCode(int)
Provides a hash code based on the given integer value.- Parameters:
i
- The integer value- Returns:
i
-
hashCode
Deprecated.Provides a hash code for the object -- defending againstnull
.- Parameters:
object
- The object for which a hash code is required.- Returns:
object.hashCode
or0
ifobject
ifnull
.
-
hashCode
Deprecated.Computes the hash code for an array of objects, but with defense againstnull
.- Parameters:
objects
- The array of objects for which a hash code is needed; may benull
.- Returns:
- The hash code for
objects
; or0
ifobjects
isnull
.
-
startsWith
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 benull
.right
- The second array to compare (small); may benull
.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
Converts an array into a string representation that is suitable for debugging.- Parameters:
array
- The array to convert; may benull
.- 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 benull
.key
- The key to look up in the resource bundle; should not benull
.defaultString
- The value to return if the resource cannot be found; may benull
.- Returns:
- The value of the translated resource at
key
. If the key cannot be found, then it is simply thedefaultString
.
-
replaceAll
Foundation replacement forString#replaceAll(String, String)
, but without support for regular expressions.- Parameters:
src
- the original stringfind
- the string to findreplacement
- the replacement string- Returns:
- the new string, with all occurrences of
find
replaced byreplacement
(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.Common WS query helper method.- Returns:
true
for motif platforms- Since:
- 3.5
-
isPhoton
Deprecated.Common WS query helper method.- Returns:
true
for photon platforms- Since:
- 3.5
-
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
Common WS query helper method.- Returns:
- the SWT windowing platform string.
- Since:
- 3.5
- See Also:
-
getClosestMonitor
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
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
-
Arrays.equals(Object[], Object[])