HelpContextUtils Class

com.bea.ide.util
HelpContextUtils Class

public class HelpContextUtils

    extends Object
Hierarchy
Object
  HelpContextUtils

Constructor Summary
HelpContextUtils()
 

Method Summary
public static URI
getJavaClassURN(String className, String fragment)
public static void
getJavaClassURNs(ArrayList uriList, String[] classNames)
create help context ID URNs for each of the classes named in classNames.
public static URI
getJavadocClassURN(String className, String fragment)
public static URI
getJavadocTagURN(String tagName)
public static URI
getJavaKeywordURN(String keywordName)
public static void
getJavaMemberURNs(ArrayList uriList, String[] classNames, String memberName, String[] argTypes)
populate an ArrayList of URNs for a Java member.
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail

HelpContextUtils

public HelpContextUtils()
 

Method Detail

getJavaClassURN(String, String) Method

public static URI getJavaClassURN(String className, 
                                  String fragment)

getJavaClassURNs(ArrayList, String[]) Method

public static void getJavaClassURNs(ArrayList uriList, 
                                    String[] classNames)
create help context ID URNs for each of the classes named in classNames. Return the URNs as URIs in uriList

Parameters

uriList
an ArrayList of URIs, must be supplied as a non-null (but possibly empty) ArrayList

Returns

the list of URNs for classNames as URIs in uriList

getJavadocClassURN(String, String) Method

public static URI getJavadocClassURN(String className, 
                                     String fragment)

getJavadocTagURN(String) Method

public static URI getJavadocTagURN(String tagName)

getJavaKeywordURN(String) Method

public static URI getJavaKeywordURN(String keywordName)

getJavaMemberURNs(ArrayList, String[], String, String[]) Method

public static void getJavaMemberURNs(ArrayList uriList, 
                                     String[] classNames, 
                                     String memberName, 
                                     String[] argTypes)
populate an ArrayList of URNs for a Java member. Can be called from any help driver to build the list of member URNs consistently. uriList must be a non-null (but possibly empty) ArrayList. If the member is a field or is a method that takes no arguments, argTypes may be null. We use the Javadoc pattern for filenames and anchors within files for methods and fields. So the URN for a method in a class is: ClassName.html#methodName(Arg1Type, Arg2Type) Return the ordered list: urn:java-class:package.Class#Method(Arg1Type, Arg2Type) urn:java-class:package.SuperClass#Method(Arg1Type, Arg2Type) urn:java-class:package.SuperSuperClass#Method(Arg1Type, Arg2Type) urn:java-class:package.Class#Method urn:java-class:package.SuperClass#Method urn:java-class:package.SuperSuperClass#Method urn:java-class:package.Class urn:java-class:package.SuperClass urn:java-class:package.SuperSuperClass ...

Parameters

uriList
a non-null, but possibly empty, Array List to which the generated URNs will be added as URIs
classNames
ordered array of fully-qualified class and interface names representing the inheritance hierarchy of the target object
memberName
the field or method name that is the target of F1 help
argTypes
for a method, an ordered array of the fully-qualified type names of the method arguments