org.das2.jythoncompletion

Class JavadocLookup

java.lang.Object

org.das2.jythoncompletion.JavadocLookup

public class JavadocLookup
extends java.lang.Object

Provide a class for keeping track of the Javadoc lookups, so this is not buried in code (so much).

Constructor Summary

Constructors

Constructor and Description
JavadocLookup()

Method Summary

Modifier and Type	Method and Description
static JavadocLookup	getInstance() get the one instance
java.lang.String	getLinkForJavaSignature(java.lang.String signature) return a link to the documentation for a java signature.
java.util.List<java.lang.String>	searchForSignature(java.lang.String clas) given a class name, what are fully-qualified class names which match?
void	setLinkForJavaSignature(java.lang.String signatureStart, java.lang.String link) add the location of the javadocs for the given path.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocLookup

public JavadocLookup()

Method Detail

getInstance

public static JavadocLookup getInstance()

get the one instance

Returns:

the instance

getLinkForJavaSignature

public java.lang.String getLinkForJavaSignature(java.lang.String signature)

return a link to the documentation for a java signature. For standard library things, this goes to Oracle's website. For other things, this goes to the Autoplot/Das2 javadocs. Java8 http://docs.oracle.com/javase/8/docs/api/java/io/File.html#createTempFile-java.lang.String-java.lang.String-java.io.File-

Parameters:

signature - signature like javax.swing.JCheckBox#paramString()

Returns:

null or the link, like http://docs.oracle.com/javase/6/docs/api/javax/swing/JCheckBox#paramString() TODO: it appears that this needs /x/y/z.html!

setLinkForJavaSignature

public void setLinkForJavaSignature(java.lang.String signatureStart,
                                    java.lang.String link)

add the location of the javadocs for the given path. The path should be / separated, not period separated.

Parameters:

signatureStart - e.g. "gov/nasa/gsfc/spdf/cdfj"

link - e.g. "https://cdaweb.sci.gsfc.nasa.gov/~nand/cdfj/docs/"

searchForSignature

public java.util.List<java.lang.String> searchForSignature(java.lang.String clas)

given a class name, what are fully-qualified class names which match?

Parameters:

clas -

Returns: