org.fife.rsta.ac.java

Class Util

java.lang.Object

org.fife.rsta.ac.java.Util

public class Util
extends java.lang.Object

Utility methods for Java completion.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	docCommentToHtml(java.lang.String dc) Converts a Java documentation comment to HTML.
static java.lang.String	forXML(java.lang.String aText)
static CompilationUnit	getCompilationUnitFromDisk(SourceLocation loc, ClassFile cf) Used by MemberCompletion.Data implementations to get an AST from a source file in a SourceLocation.
static java.lang.String	getUnqualified(java.lang.String clazz) Returns the "unqualified" version of a (possibly) fully-qualified class name.
static boolean	isFullyQualified(java.lang.String str) Returns whether the specified string is "fully qualified," that is, whether it contains a '.' character.
static java.lang.String[]	splitOnChar(java.lang.String str, int ch) A faster way to split on a single char than String#split(), since we'll be doing this in a tight loop possibly thousands of times (rt.jar).

Methods inherited from class java.lang.Object

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

Method Detail

docCommentToHtml

public static final java.lang.String docCommentToHtml(java.lang.String dc)

Converts a Java documentation comment to HTML.

 This is a
 pre block

Parameters:

dc - The documentation comment.

Returns:

An HTML version of the comment.

forXML

public static java.lang.String forXML(java.lang.String aText)

getCompilationUnitFromDisk

public static CompilationUnit getCompilationUnitFromDisk(SourceLocation loc,
                                                         ClassFile cf)

Used by MemberCompletion.Data implementations to get an AST from a source file in a SourceLocation. Classes should prefer this method over calling into the location directly since this method caches the most recent result for performance.

Parameters:

loc - A directory or zip/jar file.

cf - The ClassFile representing the source grab from the location.

Returns:

The compilation unit, or null if it is not found or an IO error occurs.

getUnqualified

public static final java.lang.String getUnqualified(java.lang.String clazz)

Returns the "unqualified" version of a (possibly) fully-qualified class name.

Parameters:

clazz - The class name.

Returns:

The unqualified version of the name.

isFullyQualified

public static final boolean isFullyQualified(java.lang.String str)

Returns whether the specified string is "fully qualified," that is, whether it contains a '.' character.

Parameters:

str - The string to check.

Returns:

Whether the string is fully qualified.

See Also:

getUnqualified(String)

splitOnChar

public static final java.lang.String[] splitOnChar(java.lang.String str,
                                                   int ch)

A faster way to split on a single char than String#split(), since we'll be doing this in a tight loop possibly thousands of times (rt.jar). This is also fundamentally different than String.split(String)), in the case where str ends with ch - this method will return an empty item at the end of the returned array, while String#split() will not.

Parameters:

str - The string to split.

ch - The char to split on.

Returns:

The string, split on the character (e.g. '/' or '.').