BaseUtilities (Base Utilities API)

java.lang.Object
- org.openide.util.BaseUtilities

public abstract class BaseUtilities
extends Object

General purpose utility methods.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`OS_AIX` Operating system is IBM AIX.
`static int`	`OS_DEC` Deprecated. please use OS_TRU64 instead
`static int`	`OS_FREEBSD` Operating system is FreeBSD
`static int`	`OS_HP` Operating system is HP-UX.
`static int`	`OS_IRIX` Operating system is SGI IRIX.
`static int`	`OS_LINUX` Operating system is Linux.
`static int`	`OS_MAC` Operating system is Mac.
`static int`	`OS_OPENBSD` Operating system is OpenBSD.
`static int`	`OS_OS2` Operating system is OS/2.
`static int`	`OS_OTHER` Operating system is unknown.
`static int`	`OS_SOLARIS` Operating system is Solaris.
`static int`	`OS_SUNOS` Operating system is Sun OS.
`static int`	`OS_TRU64` Operating system is Compaq TRU64 Unix
`static int`	`OS_UNIX_MASK` Deprecated. Use `isUnix()` instead.
`static int`	`OS_UNIX_OTHER` Operating system is one of the Unix variants but we don't know which one it is.
`static int`	`OS_VMS` Operating system is Compaq OpenVMS
`static int`	`OS_WIN_OTHER` Operating system is one of the Windows variants but we don't know which one it is
`static int`	`OS_WIN2000` Operating system is Windows 2000.
`static int`	`OS_WIN95` Operating system is Windows 95.
`static int`	`OS_WIN98` Operating system is Windows 98.
`static int`	`OS_WINDOWS_MASK` Deprecated. Use `isWindows()` instead.
`static int`	`OS_WINNT` Operating system is Windows NT.
`static int`	`OS_WINVISTA` Operating system is Windows Vista.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ReferenceQueue<Object>`	`activeReferenceQueue()` Useful queue for all parts of system that use `java.lang.ref.Reference`s together with some `ReferenceQueue` and need to do some clean up when the reference is enqueued.
`static boolean`	`compareObjects(Object o1, Object o2)` Safe equality check.
`static boolean`	`compareObjectsImpl(Object o1, Object o2, int checkArraysDepth)` Safe equality check with array recursion.
`static String`	`escapeParameters(String[] params)` Complementary method to parseParameters
`static String`	`getClassName(Class<?> clazz)` Assemble a human-presentable class name for a specified class.
`static Class<?>`	`getObjectType(Class<?> c)` Get the object type for given primitive type.
`static int`	`getOperatingSystem()` Get the operating system on which NetBeans is running.
`static Class<?>`	`getPrimitiveType(Class<?> c)` Get the primitive type for given object type.
`static String`	`getShortClassName(Class<?> clazz)` Assemble a human-presentable class name for a specified class (omitting the package).
`static boolean`	`isJavaIdentifier(String id)` Test whether a given string is a valid Java identifier.
`static boolean`	`isMac()` Test whether NetBeans is running on Mac OS X.
`static boolean`	`isUnix()` Test whether NetBeans is running on some variant of Unix.
`static boolean`	`isWindows()` Test whether NetBeans is running on some variant of Windows.
`static String[]`	`parseParameters(String s)` Parses parameters from a given string in shell-like manner.
`static String`	`pureClassName(String fullName)` Turn full name of an inner class into its pure form.
`static File`	`toFile(URI u)` Converts a URI to a file while being safe for UNC paths.
`static Object[]`	`toObjectArray(Object array)` Convert an array of primitive types to an array of objects.
`static <T> List<T>`	`topologicalSort(Collection<? extends T> c, Map<? super T,? extends Collection<? extends T>> edges)` Topologically sort some objects.
`static Object`	`toPrimitiveArray(Object[] array)` Convert an array of objects to an array of primitive types.
`static URI`	`toURI(File f)` Converts a file to a URI while being safe for UNC paths.
`static String`	`translate(String className)` Provides support for parts of the system that deal with classnames (use `Class.forName`, `NbObjectInputStream`, etc.) or filenames in layers.
`static String`	`wrapString(String original, int width, BreakIterator breakIterator, boolean removeNewLines)` Wrap multi-line strings.
`static String[]`	`wrapStringToArray(String original, int width, BreakIterator breakIterator, boolean removeNewLines)` Wrap multi-line strings (and get the individual lines).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OS_WINNT
```
public static final int OS_WINNT
```
    Operating system is Windows NT.
    
    See Also:
    
    Constant Field Values
  - OS_WIN95
```
public static final int OS_WIN95
```
    Operating system is Windows 95.
    
    See Also:
    
    Constant Field Values
  - OS_WIN98
```
public static final int OS_WIN98
```
    Operating system is Windows 98.
    
    See Also:
    
    Constant Field Values
  - OS_SOLARIS
```
public static final int OS_SOLARIS
```
    Operating system is Solaris.
    
    See Also:
    
    Constant Field Values
  - OS_LINUX
```
public static final int OS_LINUX
```
    Operating system is Linux.
    
    See Also:
    
    Constant Field Values
  - OS_HP
```
public static final int OS_HP
```
    Operating system is HP-UX.
    
    See Also:
    
    Constant Field Values
  - OS_AIX
```
public static final int OS_AIX
```
    Operating system is IBM AIX.
    
    See Also:
    
    Constant Field Values
  - OS_IRIX
```
public static final int OS_IRIX
```
    Operating system is SGI IRIX.
    
    See Also:
    
    Constant Field Values
  - OS_SUNOS
```
public static final int OS_SUNOS
```
    Operating system is Sun OS.
    
    See Also:
    
    Constant Field Values
  - OS_TRU64
```
public static final int OS_TRU64
```
    Operating system is Compaq TRU64 Unix
    
    See Also:
    
    Constant Field Values
  - OS_DEC
```
@Deprecated
public static final int OS_DEC
```
    Deprecated. please use OS_TRU64 instead
    
    See Also:
    
    Constant Field Values
  - OS_OS2
```
public static final int OS_OS2
```
    Operating system is OS/2.
    
    See Also:
    
    Constant Field Values
  - OS_MAC
```
public static final int OS_MAC
```
    Operating system is Mac.
    
    See Also:
    
    Constant Field Values
  - OS_WIN2000
```
public static final int OS_WIN2000
```
    Operating system is Windows 2000.
    
    See Also:
    
    Constant Field Values
  - OS_VMS
```
public static final int OS_VMS
```
    Operating system is Compaq OpenVMS
    
    See Also:
    
    Constant Field Values
  - OS_WIN_OTHER
```
public static final int OS_WIN_OTHER
```
    Operating system is one of the Windows variants but we don't know which one it is
    
    See Also:
    
    Constant Field Values
  - OS_OTHER
```
public static final int OS_OTHER
```
    Operating system is unknown.
    
    See Also:
    
    Constant Field Values
  - OS_FREEBSD
```
public static final int OS_FREEBSD
```
    Operating system is FreeBSD
    
    Since:
    
    4.50
    
    See Also:
    
    Constant Field Values
  - OS_WINVISTA
```
public static final int OS_WINVISTA
```
    Operating system is Windows Vista.
    
    Since:
    
    7.17
    
    See Also:
    
    Constant Field Values
  - OS_UNIX_OTHER
```
public static final int OS_UNIX_OTHER
```
    Operating system is one of the Unix variants but we don't know which one it is.
    
    Since:
    
    7.18
    
    See Also:
    
    Constant Field Values
  - OS_OPENBSD
```
public static final int OS_OPENBSD
```
    Operating system is OpenBSD.
    
    Since:
    
    7.18
    
    See Also:
    
    Constant Field Values
  - OS_WINDOWS_MASK
```
@Deprecated
public static final int OS_WINDOWS_MASK
```
    Deprecated. Use isWindows() instead.
    
    A mask for Windows platforms.
    
    See Also:
    
    Constant Field Values
  - OS_UNIX_MASK
```
@Deprecated
public static final int OS_UNIX_MASK
```
    Deprecated. Use isUnix() instead.
    
    A mask for Unix platforms.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - activeReferenceQueue
```
public static ReferenceQueue<Object> activeReferenceQueue()
```
    Useful queue for all parts of system that use java.lang.ref.References together with some ReferenceQueue and need to do some clean up when the reference is enqueued. Usually, in order to be notified about that, one needs to either create a dedicated thread that blocks on the queue and is Object.notify-ed, which is the right approach but consumes valuable system resources (threads) or one can periodically check the content of the queue by RequestProcessor.Task.schedule which is completely wrong, because it wakes up the system every (say) 15 seconds. In order to provide useful support for this problem, this queue has been provided.
    If you have a reference that needs cleanup, make it implement Runnable and register it with the queue:
```
 class MyReference extends WeakReference implements Runnable {
     private final OtherInfo dataToCleanUp;
     public MyReference(Thing ref, OtherInfo data) {
         super(ref, Utilities.queue());
         dataToCleanUp = data;
     }
     public void run() {
         dataToCleanUp.releaseOrWhateverYouNeed();
     }
 }
 
```
    When the ref object is garbage collected, your run method will be invoked by calling ((Runnable) reference).run() and you can perform whatever cleanup is necessary. Be sure not to block in such cleanup for a long time as this prevents other waiting references from cleaning themselves up.
    Do not call any ReferenceQueue methods. They will throw exceptions. You may only enqueue a reference.
    Be sure to call this method anew for each reference. Do not attempt to cache the return value.
    Since:
    
    3.11
  - getOperatingSystem
```
public static int getOperatingSystem()
```
    Get the operating system on which NetBeans is running.
    
    Returns:
    
    one of the OS_* constants (such as OS_WINNT)
  - isWindows
```
public static boolean isWindows()
```
    Test whether NetBeans is running on some variant of Windows.
    
    Returns:
    
    true if Windows, false if some other manner of operating system
  - isMac
```
public static boolean isMac()
```
    Test whether NetBeans is running on Mac OS X.
    
    Returns:
    
    true if Mac, false if some other manner of operating system
    
    Since:
    
    7.7
  - isUnix
```
public static boolean isUnix()
```
    Test whether NetBeans is running on some variant of Unix. Linux is included as well as the commercial vendors and Mac OS X.
    
    Returns:
    
    true some sort of Unix, false if some other manner of operating system
  - isJavaIdentifier
```
public static boolean isJavaIdentifier(String id)
```
    Test whether a given string is a valid Java identifier.
    
    Parameters:
    
    id - string which should be checked
    
    Returns:
    
    true if a valid identifier
    
    See Also:
    
    SourceVersion.isIdentifier(java.lang.CharSequence), SourceVersion.isKeyword(java.lang.CharSequence)
  - wrapStringToArray
```
public static String[] wrapStringToArray(String original,
                                         int width,
                                         BreakIterator breakIterator,
                                         boolean removeNewLines)
```
    Wrap multi-line strings (and get the individual lines).
    
    Parameters:
    
    original - the original string to wrap
    
    width - the maximum width of lines
    
    breakIterator - breaks original to chars, words, sentences, depending on what instance you provide.
    
    removeNewLines - if true, any newlines in the original string are ignored
    
    Returns:
    
    the lines after wrapping
  - wrapString
```
public static String wrapString(String original,
                                int width,
                                BreakIterator breakIterator,
                                boolean removeNewLines)
```
    Wrap multi-line strings.
    
    Parameters:
    
    original - the original string to wrap
    
    width - the maximum width of lines
    
    breakIterator - algorithm for breaking lines
    
    removeNewLines - if true, any newlines in the original string are ignored
    
    Returns:
    
    the whole string with embedded newlines
  - pureClassName
```
public static String pureClassName(String fullName)
```
    Turn full name of an inner class into its pure form.
    
    Parameters:
    
    fullName - e.g. some.pkg.SomeClass$Inner
    
    Returns:
    
    e.g. Inner
  - compareObjects
```
public static boolean compareObjects(Object o1,
                                     Object o2)
```
    Safe equality check. The supplied objects are equal if:
    - both are null
    - both are arrays with same length and equal items (if the items are arrays, they are not checked the same way again)
    - the two objects are Object.equals(java.lang.Object)
    This method is null-safe, so if one of the parameters is true and the second not, it returns false.
    Use java.util.Objects.deepEquals in JDK 7.
    Parameters:
    
    o1 - the first object to compare
    
    o2 - the second object to compare
    
    Returns:
    
    true if the objects are equal
  - compareObjectsImpl
```
public static boolean compareObjectsImpl(Object o1,
                                         Object o2,
                                         int checkArraysDepth)
```
    Safe equality check with array recursion.
    Use java.util.Objects.deepEquals in JDK 7.
    
    Parameters:
    
    o1 - the first object to compare
    
    o2 - the second object to compare
    
    checkArraysDepth - the depth to which arrays should be compared for equality (negative for infinite depth, zero for no comparison of elements, one for shallow, etc.)
    
    Returns:
    
    true if the objects are equal
    
    See Also:
    
    compareObjects(Object, Object)
  - getClassName
```
public static String getClassName(Class<?> clazz)
```
    Assemble a human-presentable class name for a specified class. Arrays are represented as e.g. java.lang.String[].
    
    Parameters:
    
    clazz - the class to name
    
    Returns:
    
    the human-presentable name
  - getShortClassName
```
public static String getShortClassName(Class<?> clazz)
```
    Assemble a human-presentable class name for a specified class (omitting the package). Arrays are represented as e.g. String[].
    
    Parameters:
    
    clazz - the class to name
    
    Returns:
    
    the human-presentable name
  - toPrimitiveArray
```
public static Object toPrimitiveArray(Object[] array)
```
    Convert an array of objects to an array of primitive types. E.g. an Integer[] would be changed to an int[].
    
    Parameters:
    
    array - the wrapper array
    
    Returns:
    
    a primitive array
    
    Throws:
    
    IllegalArgumentException - if the array element type is not a primitive wrapper
  - toObjectArray
```
public static Object[] toObjectArray(Object array)
```
    Convert an array of primitive types to an array of objects. E.g. an int[] would be turned into an Integer[].
    
    Parameters:
    
    array - the primitive array
    
    Returns:
    
    a wrapper array
    
    Throws:
    
    IllegalArgumentException - if the array element type is not primitive
  - getObjectType
```
public static Class<?> getObjectType(Class<?> c)
```
    Get the object type for given primitive type.
    
    Parameters:
    
    c - primitive type (e.g. int)
    
    Returns:
    
    object type (e.g. Integer)
  - getPrimitiveType
```
public static Class<?> getPrimitiveType(Class<?> c)
```
    Get the primitive type for given object type.
    
    Parameters:
    
    c - object type (e.g. Integer)
    
    Returns:
    
    primitive type (e.g. int)
  - parseParameters
```
public static String[] parseParameters(String s)
```
    Parses parameters from a given string in shell-like manner. Users of the Bourne shell (e.g. on Unix) will already be familiar with the behavior. For example, when using org.openide.execution.NbProcessDescriptor (Execution API) you should be able to:
    - Include command names with embedded spaces, such as c:\Program Files\jdk\bin\javac.
    - Include extra command arguments, such as -Dname=value.
    - Do anything else which might require unusual characters or processing. For example:
      "c:\program files\jdk\bin\java" -Dmessage="Hello /\\/\\ there!" -Xmx128m
      
      This example would create the following executable name and arguments:
      
      c:\program files\jdk\bin\java
      -Dmessage=Hello /\/\ there!
      -Xmx128m
      Note that the command string does not escape its backslashes--under the assumption that Windows users will not think to do this, meaningless escapes are just left as backslashes plus following character.
    Caveat: even after parsing, Windows programs (such as the Java launcher) may not fully honor certain characters, such as quotes, in command names or arguments. This is because programs under Windows frequently perform their own parsing and unescaping (since the shell cannot be relied on to do this). On Unix, this problem should not occur.
    Parameters:
    
    s - a string to parse
    
    Returns:
    
    an array of parameters
  - escapeParameters
```
public static String escapeParameters(String[] params)
```
    Complementary method to parseParameters
    
    See Also:
    
    parseParameters(java.lang.String)
  - topologicalSort
```
public static <T> List<T> topologicalSort(Collection<? extends T> c,
                                          Map<? super T,? extends Collection<? extends T>> edges)
                                   throws TopologicalSortException
```
    Topologically sort some objects.
    There may not be any nulls among the objects, nor duplicates (as per hash/equals), nor duplicates among the edge lists. The edge map need not contain an entry for every object, only if it has some outgoing edges (empty but not null map values are permitted). The edge map shall not contain neither keys nor value entries for objects not in the collection to be sorted, if that happens they will be ignored (since version 7.9).
    The incoming parameters will not be modified; they must not be changed during the call and possible calls to TopologicalSortException methods. The returned list will support modifications.
    There is a weak stability guarantee: if there are no edges which contradict the incoming order, the resulting list will be in the same order as the incoming elements. However if some elements need to be rearranged, it is not guaranteed that others will not also be rearranged, even if they did not strictly speaking need to be.
    
    Parameters:
    
    c - a collection of objects to be topologically sorted
    
    edges - constraints among those objects, of type Map<Object,Collection>; if an object is a key in this map, the resulting order will have that object before any objects listed in the value
    
    Returns:
    
    a partial ordering of the objects in the collection,
    
    Throws:
    
    TopologicalSortException - if the sort cannot succeed due to cycles in the graph, the exception contains additional information to describe and possibly recover from the error
    
    Since:
    
    3.30
    
    See Also:
    
    Issue #27286
  - translate
```
public static String translate(String className)
```
    Provides support for parts of the system that deal with classnames (use Class.forName, NbObjectInputStream, etc.) or filenames in layers.
    Often class names (especially package names) changes during lifecycle of a module. When some piece of the system stores the name of a class in certain point of a time and wants to find the correct Class later it needs to count with the possibility of rename.
    For such purposes this method has been created. It allows modules to register their classes that changed names and other parts of system that deal with class names to find the correct names.
    To register a mapping from old class names to new ones create a file META-INF/netbeans/translate.names in your module and fill it with your mapping:
```
 #
 # Mapping of legacy classes to new ones
 #

 org.oldpackage.MyClass=org.newpackage.MyClass # rename of package for one class
 org.mypackage.OldClass=org.mypackage.NewClass # rename of class in a package

 # rename of class and package
 org.oldpackage.OldClass=org.newpackage.NewClass

 # rename of whole package
 org.someoldpackage=org.my.new.package.structure

 # class was removed without replacement
 org.mypackage.OldClass=

 
```
    Btw. one can use spaces instead of = sign. For a real world example check the xml module.
    For purposes of org.openide.util.io.NbObjectInputStream there is a following special convention: If the className is not listed as one that is to be renamed, the returned string == className, if the className is registered to be renamed than the className != returned value, even in a case when className.equals (retValue)
    Similar behaviour applies to filenames provided by layers (system filesystem). Filenames can be also translated to adapt to location changes e.g. in action registrations. Note that no spaces or special characters are allowed in both translated filenames or translation results. Filenames must conform to regexp ^[/a-zA-Z0-9$_.+-]+$. Keys and values are treated as paths from fs root.
    Example of file path translation (action registration file has moved):
```
 # registration ID has changed
 Actions/Refactoring/RefactoringWhereUsed.instance=Actions/Refactoring/org-netbeans-modules-refactoring-api-ui-WhereUsedAction.instance
 
```
    Parameters:
    
    className - fully qualified name of a class, or file path to translate
    
    Returns:
    
    new name of the class according to renaming rules.
  - toURI
```
public static URI toURI(File f)
```
    Converts a file to a URI while being safe for UNC paths. Uses f.toPath().toUri() which results into URI that works with URI.normalize() and URI.resolve(URI).
    
    Parameters:
    
    f - a file
    
    Returns:
    
    a file-protocol URI which may use the host field
    
    Since:
    
    8.25
    
    See Also:
    
    Path.toUri
  - toFile
```
public static File toFile(URI u)
                   throws IllegalArgumentException
```
    Converts a URI to a file while being safe for UNC paths. Uses Paths.get(u).toFile() which accepts UNC URIs with a host field.
    
    Parameters:
    
    u - a file-protocol URI which may use the host field
    
    Returns:
    
    a file
    
    Throws:
    
    IllegalArgumentException
    
    Since:
    
    8.25
    
    See Also:
    
    Paths.get(java.net.URI)

Class BaseUtilities

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OS_WINNT

OS_WIN95

OS_WIN98

OS_SOLARIS

OS_LINUX

OS_HP

OS_AIX

OS_IRIX

OS_SUNOS

OS_TRU64

OS_DEC

OS_OS2

OS_MAC

OS_WIN2000

OS_VMS

OS_WIN_OTHER

OS_OTHER

OS_FREEBSD

OS_WINVISTA

OS_UNIX_OTHER

OS_OPENBSD

OS_WINDOWS_MASK

OS_UNIX_MASK

Method Detail

activeReferenceQueue

getOperatingSystem

isWindows

isMac

isUnix

isJavaIdentifier

wrapStringToArray

wrapString

pureClassName

compareObjects

compareObjectsImpl

getClassName

getShortClassName

toPrimitiveArray

toObjectArray

getObjectType

getPrimitiveType

parseParameters

escapeParameters

topologicalSort

translate

toURI

toFile